DPF CLI¶

DPF CLI is the command line tool for administrating Digital Process Factory. It is used for managing the system configuration and the services. As of DPF 4.0.0, DPF CLI replaces the former DPF Admin Client.

Requirements¶

Call DPF CLI¶

Windows: In a Command Prompt or in a PowerShell
Linux: In a Linux shell

To call DPF CLI enter the following command:

dpf [options] [command]

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  clearjobs       clear jobs
  config          manage configuration
  service         manage services
  help [command]  display help for command

Privileges¶

The commands for administrating the services execute PowerShell scripts on Windows and bash scripts on Linux. For more information about the privileges for this, refer to the installation requirements for on-premise Windows or for on-premise Linux.

Display the Version of DPF CLI¶

dpf --version

Display the Usage of DPF CLI¶

dpf --help

DPF CLI Commands in Detail¶

Refer to the description of the specific DPF CLI commands: