Help Center

Menu

DXP commands and options

The top-level commands of the DXP CLI execute functions that affect the DXP CLI instance itself or invoke the required DXP service.

These commands can be reviewed using the dxp-next --help command, the output of which is shown below:

Usage: dxp-next [options] [command]

dxp-next commands

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

Commands:
  auth           Authenticate into the DXP CLI
  cmp            Component Service Commands
  job-runner     Job Runner Service Commands
  datastore      Datastore Commands
  cdp            Customer Data Platform Service Commands

dxp-next auth

Usage: dxp-next auth [options] [command]

Authenticate into the DXP CLI

Options:

  -h, --help       display help for command

Commands:
  login [options]  Login to the DXP platform
  help [command]   display help for command

dxp-next auth login

Usage: dxp-next auth login [options]

Login to the DXP platform

Options:

  --dxp-base-url <baseURL>  dxp cloud base url e.g. "https://develop-apps-dxp-console.dev.dxp.squiz.cloud/" (default: "https://dxp.squiz.cloud", env:
                            DXP_BASE_URL)
  --region <region>          (choices: "au", default: "au")
  --override-session        Override the existing authorized session if it exists
  --tenant <tenantID>
  -h, --help                display help for command

dxp-next auth login help

Usage: dxp-next auth [options] [command]

Authenticate into the DXP CLI

Options:

  -h, --help       display help for command

Commands:
  login [options]  Login to the DXP platform
  help [command]   display help for command