DXP Console commands

The following sections list and describe the base CLI commands available for all Squiz DXP products.

dxp help


Shows command line help for the dxp command and lists all other dxp commands currently available with the DXP Console CLI tool.

Parameters

None.

dxp login


Logs you in to your Squiz DXP Console account.

Required parameters
--username

The username (email address) of your DXP Console account.

Optional parameters
--password

The password associated with the username for your DXP Console account. When not specified, you will be prompted for a password.

Example
dxp login --username alex@example.com --password <password-entered-here>

Logs user alex@example.com in to their DXP Console account.

dxp logout


Logs you (the current user) out of your DXP Console account.

Parameters

None.

dxp plugin add


Adds a new CLI tool plugin to your local DXP Console CLI tool installation.

The DXP Console CLI tool’s functionality can be extended by adding new CLI tool plugins to your local DXP Console CLI tool installation.

This command requires the value of the CLI tool plugin to be specified after add.

Parameters

None.

Example
dxp plugin add @squiz/dxp-plugin-datastore

Adds the Datastore CLI tool plugin to your local DXP Console CLI tool installation, thereby providing you with the complete set of Datastore CLI tools.

dxp plugin remove


Removes a CLI tool plugin from your local DXP Console CLI tool installation.

If you no longer require the features offered by a CLI tool plugin you previously added to your local DXP Console CLI tool installation, you can remove the plugin using this command.

This command requires the value of the CLI tool plugin to be specified after remove.

Parameters

None.

Example
dxp plugin remove @squiz/dxp-plugin-datastore

Removes the Datastore CLI tool plugin from your local DXP Console CLI tool installation, thereby paring it back to just the DXP Console CLI tool and any other CLI tool plugins you have installed.

dxp whoami


Returns the email address of the current user who is logged in to the Squiz DXP.

Parameters

None.