Using the command line interface

Workplace Manager command line interface can be used to perform many of the functions which are available in the web interface as well as some which are not.

The command line tool is named 'wpm-cli' and can be found in the Digital Assistant installation directory inside Web → bin folder.

Location of cli tool

To run the command line tool, open the Command Prompt and change the directory to be the same as the location of 'wpm-cli' file. In our case:

cd C:\Program Files\adenin Workplace\Web\bin

Running wpm-cli in the Command Prompt will start a session:

Initializing the session

Using commands

To view a list of available commands, type 'help commands' at the prompt:

CLI help

Installation of Digital Assistant

If you run 'wpm-cli' before you have set up Digital Assistant, the only command you can run is 'setup'. This has the exactly same function as running Digital Assistant installation in the browser and completing the setup form (to enter a site name, admin user name, password, and database options).

Enabling or disabling features

The list of available commands depends on the features that are currently enabled in Digital Assistant. To see a list of features that you can enable or disable, use commands feature list or feature list /Summary:true for a summarized list. You can enable additional features (and thus, additional commands), by using feature enable <feature-name> at the command-prompt.

Batched or scripted Commands

In the command line interface commands can be executed in two ways: as a single command or using a response file.

Single command

A single command runs wpm-cli.exe tool and exits directly after completion. For example:

wpm-cli feature enable <feature-name>

Would enable a feature and close the 'wpm-cli' tool after finishing.

Response file

A response file contains multiple commands to be executed. This is an excellent way to run multiple commands without the need to fully initialize 'wpm-cli' or as part of a build process.

To execute a response file run the 'wpm-cli' in the single command mode as above, but add the '@' prefix on the parameter, indicating a response file. Note that you need to indicate the full path to the response file after the prefix.

For example a response file 'test.txt':

Test response file

Would be run with the following command:

wpm-cli @test.txt