Using GuardMode Agent Command Line

Tip. Always run PowerShell as an Administrator when working with the GuardMode Agent command line interface.

GuardMode Agent exposes a command line interface (CLI) that can be used to modify its configuration and behavior.

To use GuardMode Agent CLI, navigate to the directory where GuardMode Agent is installed and locate executable files. On Windows, this file is named Catalogic.GuardMode.Agent.exe and on Linux, it is Catalogic.GuardMode.Agent.

All top-level commands are listed when running the below:

PowerShell

.\Catalogic.GuardMode.Agent.exe --help

Bash

./Catalogic.GuardMode.Agent --help

To get help for a specific subcommand or a group of commands, run the command with the --help flag, for example:

PowerShell

.\Catalogic.GuardMode.Agent.exe config --help

Bash

./Catalogic.GuardMode.Agent --help

To see all required parameters and the description of a command, run the command with the --help flag, for example:

PowerShell

.\Catalogic.GuardMode.Agent.exe config add notification-provider dpx --help

Bash

./Catalogic.GuardMode.Agent config add notification-provider dpx --help

See also. For a complete list of available CLI commands, see Agent CLI Reference.