Agent command line usage

The user should remember to always run PowerShell as an Administrator when working with the command line interface

The agent exposes a command line interface that can be used to modify its configuration and behavior.

In order to use GuardMode Agent commands, the user needs to navigate to the directory where GuardMode Agent is installed and locate executable files. In Windows this file is named Catalogic.GuardMode.Agent.exe and in Linux it is the executable file namedCatalogic.GuardMode.Agent.

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

Windows command line

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

Linux bash

./Catalogic.GuardMode.Agent --help

To see help for a specific subcommand or a group of commands, the user should run it with the --help flag as well, for example:

Windows command line

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

Linux bash

./Catalogic.GuardMode.Agent --help

Listing all required parameters along with their description can be run using the most specific subcommand with --help flag, for example:

Windows command line

.\Catalogic.GuardMode.Agent.exe config add notification-provider dpx --help (For Windows)

Linux bash

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