-
Notifications
You must be signed in to change notification settings - Fork 6
Node.js, NPM and NPX requirements
To use the Coveo CLI for UI purposes, we recommend using nvm
with an LTS (Long Term Support) version of Node.js (see Node.js Releases).
Note: The Coveo CLI will not 'switch' the Node version you're using, and the requirements listed below still apply when using nvm. In other words, you must use a Node version that meets the following requirements before running Coveo CLI commands.
The following table describes the software requirements needed to execute certain Coveo CLI commands:
Command | Node.js | npm | npx |
---|---|---|---|
ui:create:react |
✔️ (v.10.16.0 or higher) | ✔️ | ✔️ |
ui:create:vue |
✔️ (v.12.21.0 or higher) | ✔️ | ✔️ |
ui:create:angular |
✔️ (v.12.21.0 or higher) | ✔️ | ❌ |
Notes: While npx and npm are typically automatically installed with recent versions of Node.js, since the CLI version 3.2.6, the Coveo CLI is now using the PowerShell scripts (*.ps1) entry points of this CLI (and other npm-based CLIs, such as
ng
) on Windows platform. Starting with Node 22 LTS 'Jod', these entry points will be installed with NodeJS. For previous versions, you must install an npm version greater than 9.9 (even if you already have a version greater than 9.9 included with NodeJS). This will add the Powershell scripts to your AppData folder. To do so, simply runnpm i -g npm
if you want the latest version of npm (recommended), ornpm i -g npm@<version>
if you need a specific version.