Prerequisites
The DXP CLI is built on top of these technologies, which need to be installed on your computer.
Required
The following software must be installed or be available on your computer:
- Node.js (Version 18+)
-
Used to install and run the DXP command line interface (CLI) tools.
- npm (version 9+)
-
Used to install and run the DXP command line interface (CLI) tools.
- CLI 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) is required to run the DXP CLI tools.
- Windows 10
-
For Windows installations version 10 or later, the Windows Subsystem for Linux is suitable. To do this, follow its installation instructions in the Microsoft Docs site.
Optional
The following optional software applies to specific DXP services available through the DXP CLI.
You do not need to install these services unless required by the service.
Data Services
- Docker
-
Used by the DXP CLI tools to create Docker containers for the local Squiz Data Services simulator environment.
- Windows or macOS
-
Install Docker Desktop.
- Linux
-
Follow the appropriate installation instructions in the Docker Docs site.