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

WSL configuration

If you use an Ubuntu variant in WSL, further configuration is required to sign in using the auth login command.

  1. If it is not already installed, install xdg-utils:

    1. sudo apt-get update

    2. sudo apt-get install xdg-utils

  2. Identify the path to the default browser executable. There are multiples ways to do this using the WSL CLI. Listing them all is out of scope for this documentation.

    Keep in mind that the WSL default browser will be installed in your Windows environment, so unless you have installed your browser to a unique location, the path will begin with either /mnt/c/Program Files or /mnt/c/Program Files (x86).

    If this is the case, and the path contains a space, follow the Additional steps.

    If your executable path does not contain a space, there is no need for any further configuration.

Additional steps

  1. Create a symbolic link to the browser executable.

    ln -s /path/to/default\ browser/executable.exe ~/browser.exe

    Your path will be different and point to a binary executable. Change browser.exe to a name you will recognize (the browser’s name, for example).

    Do not forget to escape the space(s) in the path with a backslash (\).

  2. Add this symlink as a variable in ~/.bashrc:

    export BROWSER=~/browser.exe

    Use the name you chose in Step 4. Ensure you include the file extension (.exe).

  3. Reload your bash configuration:

    source ~/.bashrc

These further steps will ensure your browser will launch, allowing you to authenticate as needed.