Skip to main content
EllygentAI-assisted Systems Engineering
Login
Start free

CLI / Installation

Install Ellygent CLI

Ellygent CLI is distributed directly from GitHub source. The hosted installer scripts are convenience wrappers around the same clone, build, and install flow.

CLI Demo: Authenticate and Download Project Context

Watch a live walkthrough showing how to authenticate with the Ellygent CLI and download structured context from an existing project into a local engineering workflow.

Watch on YouTube

Install with PowerShell

Run this from PowerShell:

irm https://ellygent.com/cli/install.ps1 | iex

  • Checks that Node.js and npm are available.

  • Clones the CLI directly from https://github.com/EEQuality/ellygent-cli and builds it locally.

  • Verifies the installation with ellygent --version and ellygent --help when the command is available.

  • Prints the next login steps using PAT-only authentication.

Install with GitHub checkout

This is the canonical installation path across Windows, macOS, and Linux:

git clone --depth 1 https://github.com/EEQuality/ellygent-cli.git
cd ellygent-cli
npm install
npm run build
npm install -g .
ellygent --version
ellygent auth login --token <your-personal-access-token>
ellygent whoami

Verify Your Installation

Run these commands in a new PowerShell window:

ellygent --help
ellygent --version
ellygent auth login --token <your-personal-access-token>
ellygent whoami

Node.js Requirement

The installer scripts use npm to build and install the CLI from GitHub, so Node.js LTS must already be available.

winget install OpenJS.NodeJS.LTS

After installation, reopen PowerShell and rerun irm https://ellygent.com/cli/install.ps1 | iex.

Manual GitHub Installation

Use these commands if you want to check out a specific GitHub ref manually instead of using the hosted wrappers:

git clone --depth 1 --branch v0.1.1 https://github.com/EEQuality/ellygent-cli.git
cd ellygent-cli
npm install
npm run build
npm install -g .

Other Installation Methods

These tabs show the same GitHub-checkout install model for each platform.

Installer script

Checks for Node.js, npm, and Git, then clones the CLI from GitHub, builds it locally, and installs it.

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

Clone the CLI from GitHub, build it locally, and install it globally.

git clone --depth 1 https://github.com/EEQuality/ellygent-cli.git
cd ellygent-cli
npm install
npm run build
npm install -g .

Troubleshooting Quick Links

Open troubleshootingGo to getting started

Run where.exe ellygent or Get-Command ellygent if you want to confirm which command Windows will launch.

The expected command usually comes from your npm global bin directory, not a frontend-downloaded executable.

Back to CLI HomeNext: Getting Started