Install and upgrade

Learn how to install or upgrade the DXP command-line interface.

Install

To install the DXP CLI:

  1. Confirm you have all the Prerequisites installed and configured correctly.

  2. Execute the following installation command:

npm install --global @squiz/dxp-cli-next

This command installs the DXP CLI so it is available to all projects on the machine on which it is being installed.

Upgrade

To upgrade the DXP CLI:

  1. Confirm you have all the Prerequisites installed and configured correctly.

  2. Run dxp-next --version to check for updates.

  3. If an update is available, the version option will show a prompt similar to this output.

       ╭────────────────────────────────────────────────╮
       │                                                │
       │       Update available 5.18.0 → 5.19.1         │
       │   Run npm i -g @squiz/dxp-cli-next to update   │
       │                                                │
       ╰────────────────────────────────────────────────╯
  4. Run npm install --global @squiz/dxp-cli-next to upgrade the command line to the latest version.

  5. Run dxp-next --version to validate that the upgrade was successful, and no further updates are pending.