Skip to main content

Installation

This guide walks you through installing and setting up the EAI CLI on your machine.

Prerequisites​

Before installing the EAI CLI, ensure you have the following:

  • Node.js 20 or later -- The CLI requires Node.js version 20.0.0 or higher. Check your version with node --version.
  • npm -- Comes bundled with Node.js. Verify with npm --version.
tip

We recommend using a Node version manager like nvm or fnm to manage your Node.js installations.

# Using nvm
nvm install 20
nvm use 20

# Using fnm
fnm install 20
fnm use 20

Install via npm​

Install the EAI CLI globally using npm:

npm install -g @eai-tools/cli

Verify Installation​

After installation, verify that the CLI is available:

eai --version

You should see the current version number printed to the console (e.g., 0.1.0).

You can also view the help output to see all available commands:

eai --help

Update the CLI​

To update to the latest version of the CLI:

npm update -g @eai-tools/cli

Uninstall​

To remove the CLI from your system:

npm uninstall -g @eai-tools/cli

Troubleshooting​

eai: command not found​

If the eai command is not found after installation, your npm global bin directory may not be in your PATH. Find the directory and add it:

# Find npm global bin directory
npm config get prefix

# Add to your shell profile (~/.bashrc, ~/.zshrc, etc.)
export PATH="$(npm config get prefix)/bin:$PATH"

Permission Errors on macOS/Linux​

If you encounter EACCES permission errors during global installation, avoid using sudo. Instead, configure npm to use a different directory:

mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

Add the export PATH line to your shell profile to make it permanent.

Node.js Version Too Old​

If you see errors about unsupported Node.js features, verify your Node.js version:

node --version

The CLI requires Node.js 20 or later. If your version is older, upgrade using your preferred method (nvm, fnm, or direct download from nodejs.org).

Next Steps​

Once installed, authenticate with the platform to begin using the CLI.