Installation

Install the Ellygent CLI on macOS, Linux, or Windows using your preferred package manager.

Prerequisites

Node.js 20 or higher (for npm installation only)

Node.js is only required if installing via npm. Standalone binaries are available that require no runtime. Check your version with node --version

Note: Standalone binaries are available that do not require Node.js. See installation methods below.

Don't have Node.js but want to use npm? Download it from nodejs.org or use a version manager like nvm.

Choose Your Installation Method

Installer Script (recommended)

Automated installation with platform detection and checksum verification

curl -fsSL https://ellygent.com/cli/install.sh | sh

npm

Install using npm, the Node.js package manager (requires Node.js 20+)

npm install -g @ellygent/cli

Direct Download

Download standalone binary (Intel or Apple Silicon)

# Intel Macs
curl -L -o ellygent-macos-x64.tar.gz https://ellygent.com/downloads/cli/latest/ellygent-v0.1.0-macos-x64.tar.gz
tar -xzf ellygent-macos-x64.tar.gz
sudo mv ellygent-macos-x64 /usr/local/bin/ellygent

# Apple Silicon Macs
curl -L -o ellygent-macos-arm64.tar.gz https://ellygent.com/downloads/cli/latest/ellygent-v0.1.0-macos-arm64.tar.gz
tar -xzf ellygent-macos-arm64.tar.gz
sudo mv ellygent-macos-arm64 /usr/local/bin/ellygent

ellygent --version

Verify Installation

Confirm the CLI is installed and accessible:

ellygent --version

You should see the CLI version number (e.g., 1.0.0). If you get a "command not found" error, see Troubleshooting.

Update & Uninstall

Update to Latest Version

npm update -g @ellygent/cli

Check the current version with ellygent --version

Uninstall

npm uninstall -g @ellygent/cli

Uninstalling the CLI does not remove your configuration file. To remove all CLI data, also delete ~/.ellygent/ (Unix/macOS) or %APPDATA%\Ellygent\ (Windows).

Local Development Setup

If you're contributing to the Ellygent CLI or testing local changes:

1. Clone the Repository

git clone https://github.com/EEQuality/ellygent-cli.git
cd ellygent-cli

2. Install Dependencies

npm install

3. Build and Link

npm run build
npm link

This creates a symlink to your local build, allowing you to run ellygent commands using your development version.

4. Run Tests

npm test

5. Unlink When Done

npm unlink

Platform-Specific Notes

macOS

npm is the recommended installation method on macOS

You may need to configure npm to avoid permission issues:

mkdir ~/.npm-global && npm config set prefix '~/.npm-global'

Add ~/.npm-global/bin to your PATH in ~/.zshrc or ~/.bash_profile

Linux

Use a Node version manager like nvm to avoid permission issues
If using system Node.js, you may need to use sudo npm install -g @ellygent/cli

Windows

npm is the recommended installation method on Windows
Run PowerShell or Command Prompt as Administrator if you encounter permission errors

If PowerShell blocks script execution, set the execution policy:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Next Steps

After installation, you're ready to authenticate and start downloading engineering context:

Get Started Set Up Authentication

Back to CLI Home Next: Getting Started