Skip to main content

​
Installation

​
Supported Platforms

OSArchitectureMinimum Version
macOSIntel (x86_64)macOS 11 (Big Sur)
macOSApple Silicon (arm64)macOS 11 (Big Sur)
Linuxx86_64glibc 2.28+ (Ubuntu 20.04, Debian 11, RHEL/CentOS 8, or later)
Linuxarm64glibc 2.35+ (Ubuntu 22.04, Debian 12, or later)

​
Prerequisites

Before installing EigenData-CLI, ensure you have Node.js 18+ installed: 
node -v
If Node.js is not installed or is out of date, download it from nodejs.org.

​
Configure npm Registry

Before installing, configure npm to use the EigenAI GitHub Packages registry — contact support@eigenai.com to obtain your auth token, then run: 
echo "@eigen-ai-labs:registry=https://npm.pkg.github.com" >> ~/.npmrc
echo "//npm.pkg.github.com/:_authToken=YOUR_AUTH_TOKEN" >> ~/.npmrc

​
Install EigenData-CLI

Choose the option that matches your environment:
Install globally so the eigendata command is available system-wide:
npm install -g @eigen-ai-labs/eigendata-cli
Verify the installation:
eigendata --version
Expected output:
$ npm install -g @eigen-ai-labs/eigendata-cli
added 1 package in 20s

$ eigendata --version
2.2.10

​
Quick Start

​
Launch EigenData-CLI

Start the CLI by running: 
eigendata

​
First-Time Setup

When you run EigenData-CLI for the first time, it will guide you through the initial configuration: API Key You need an API key to authenticate with EigenData services. Get your API key from the EigenAI page. 
EigenData API Key
Used to authenticate with the EigenData server.
Get one at https://app.eigenai.com/api-keys
Example: sk-xxx
Required to start the EigenData CLI.

> ********
After completing the setup, you’ll see a confirmation: 
✓ Settings saved to ~/.eigendata/settings.yaml
✓ Authenticated as user@example.com
  Credits: 100.00
EigenData-CLI installation and authentication.

​
Start Using EigenData-CLI

Once initialization is complete, you’ll see the interactive prompt: 
eigendata>
You can now start using natural language commands: 
eigendata> Generate 10 customer support dialogs about billing issues
eigendata> Analyze outputs/my_data.jsonl and report quality issues

​
What’s Next

Now that EigenData-CLI is installed and running, explore the key concepts and features: