Help and Commands (CLI)

For more details on sub-commands, options and syntax, refer to the built-in help.

Command Structure

The APM CLI uses a multipart structure. Each command consists of:

  • A base (APM)
  • An action specifying the operation to be executed (for example: install).

  • Arguments and options, which can be specified in any order.

    Options can be specified in short form (starting with a single dash -) or in long form (starting with a double dash --). For example: -h, --help or -c, --client.

    Some options have its own arguments, that must be specified right after the option. For example: -c 20 -u UC/UC. Other options have no argument and work as a flag. For example: -v, --verbose or -h, --help.

    The CLI tool can process none, one or more arguments that are not optional, called main arguments. Main arguments and optional arguments (if available) can be entered with double quotes (” ”) or single quotes (‘ ‘) in a consistent way.

All APM commands have the following syntax:

apm <command> [option] [<arguments>]

Passwords

Passwords can be specified with the following commands: -pw or --password.

Important! The values are not displayed in the command line while typing.

Common Options

The following options are available for all APM commands:

  • -v, --verbose

    Display verbose output

    Default: false

  • -vv, --very-verbose

    Display verbose output

    Default: false

  • -y, --yes

    Respond yes to all prompted questions

    Default: false

Common Options for Automation Engine Connection Commands

  • -C <file>, <file>

    Path to uc4config.xml. Default: $PM_HOME/conf

  • -L <file>, --login-dat <file>

    Path to login_dat.xml. Default: $PM_HOME/conf

  • -T <template>, --user-template <template>

    User template that is used to connect to the AE

  • -S <system>, --system <system>

    AE system name. This command overrides the default value of the configuration file.

  • -H <host>, --host <host>

    AE hostname or IP address. This command overrides the default value of the configuration file.

  • -c <client>, --client <client>

    AE client number. This command overrides the default value of the configuration file.

  • -p <port>, --port <port>

    AE port. This command overrides the default value of the configuration file.

  • -u <user/dept>, --user <user/dept>

    AE user/dept. This command overrides the default value of the configuration file.

  • -pw [password], --password [password]

    AE password, password may be not mandatory in the command line, the tool asks for it later.

  • -l <language>, --language <language>

    AE language. This command overrides the default value of the configuration file.

  • -f <folder>, --folder <folder>

    AE folder containing all installed packages. Default: \PACKAGES

Get Help for a Command

For details on commands, call apm <command> -h or apm <command> --help.

Find More Commands

For a list of available commands, call apm -h or apm --help.

Analyze and Display Current Environment Issues

apm doctor check

Fix Current Environment Issues Detected by the Doctor Check Command

apm doctor fix

Note: Extended Packs: run this command if you want to scan for and update missing hooks and VARA objects of base Packs.

Display Pack Content

apm show [option] <pack_name>

Where [option] can be one of the following:

  • --from-file

    Read Pack from local file or directory

  • --installed

    Only show installed Pack.

    Default: false.

  • --local

    Only show Pack in local cache.

    Default: false.