Choose how to install
Server only This page is about installing expl to use with Exploratory Server. The copy that comes with Desktop can run expl server too.
With Exploratory Desktop
expl is bundled with Exploratory Desktop, including expl server. You need no extra installation and no Node.js. When you start Exploratory Desktop, it puts expl on your PATH (the list of folders where commands are found) if it is not there yet. On macOS this happens only when the app is in /Applications or ~/Applications. It may ask for administrator permission. If you decline, it uses ~/.local/bin; add that folder to your PATH if needed. An existing command called expl that is not Exploratory’s is never replaced. Open a new terminal and run this.If the first line reads expl <version>, it works.
With npm
Use this when you do not have Desktop: you only use Exploratory Server, or you run expl in CI or on a server. Node.js 20 or later is required. npm is the command that comes with Node.js for installing packages. npx runs a package without installing it. It needs Node.js 20 or later; to install Node.js, see the Node.js website.--version with it, for example server login. In scripts, pin the version: @exploratory/cli@<version>.
Check the installation
If the first line reads expl <version>, it works.If you see expl: command not found, open a new terminal and try again.
When two copies are installed
If you installed from npm and also use Desktop, check which one runs.macOS and Linux
Windows
expl --version is expl <version>. It does not say how expl was installed, so use the paths above to tell the copies apart. If the first path is not the one you expect, put the folder you want first on your PATH, or remove the other copy.
If you have Desktop, you do not need a global npm install. Using npx with a pinned version in CI is fine.
When npm install -g stops with EEXIST
On a Mac where Node.js was installed with the installer from nodejs.org, npm puts commands in /usr/local/bin, the folder Desktop normally uses, so npm install -g stops with EEXIST. Do not run it again with --force: that replaces the expl that comes with Desktop. The other way round, if expl from npm is already in /usr/local/bin, Desktop leaves it in place and does not add its own.
