Datastore CLI installation

Prerequisites

The following software must be installed or be available on your computer:

  • Node.js - used to install and run the Datastore command line interface (CLI) tools.

    DXP

    Version 14+

    DXP-Next

    Version 16+

  • npm (version 7+) - used to install and run the Datastore command line interface (CLI) tools.

  • Docker - used by Datastore’s CLI tools to create Docker containers for the local simulator environment.

  • A compatible command-line shell environment such as Bash or Zsh (available by default on most macOS or Linux systems), or Windows Terminal (on Windows) to run Datastore’s CLI tools.

Install the CLI tools

To set up the Datastore command line interface (CLI) tool locally on your computer:

  1. After meeting the prerequisites (above), install the DXP Console CLI tool, which provides the base set of commands for all Squiz DXP products:

    npm install --global @squiz/dxp-cli-next
    If you experience EACCES permission errors when running this command, follow the recommendations in this troubleshooting article to resolve these issues.
  2. Run dxp-next -V to verify you are running a version of 5.11.0 or greater which validates that you are no longer using the legacy CLI.

    dxp-next -V
    5.11.0