Legacy Datastore CLI installation
|
As of February 2024, the CLI version 0.39.0 is officially deprecated and will no longer receive active support for Datastore. While existing installations will continue to function, no new installations or updates will be supported using this version. To ensure continued support and access to the latest features, we recommend upgrading to the next CLI version. Detailed CLI instructions can be found in the Datastore DXP-Next CLI section. |
Prerequisites
The following software must be installed or be available on your computer:
-
Node.js (version 14+) and 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.
-
For Windows or macOS, install Docker Desktop.
-
For Linux, follow the appropriate installation instructions in the Docker Docs site.
-
-
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.
-
For Windows 10, you can alternatively set up the Windows Subsystem for Linux. To do this, follow its installation instructions in the Microsoft Docs site.
-
Install the CLI tools
To set up the Datastore command line interface (CLI) tool locally on your computer:
-
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
If you experience EACCES permission errors when running this command, follow the recommendations in this troubleshooting article to resolve these issues. -
Install the Datastore CLI tool, which is installed as a plugin to the DXP Console CLI tool and provides all commands relevant to working with Datastore:
dxp plugin add @squiz/dxp-plugin-datastore