Getting Started

Installation

Supported Platforms

OS	Architecture	Minimum Version
macOS	Intel (x86_64)	macOS 11 (Big Sur)
macOS	Apple Silicon (arm64)	macOS 11 (Big Sur)
Linux	x86_64	glibc 2.28+ (Ubuntu 20.04, Debian 11, RHEL/CentOS 8, or later)
Linux	arm64	glibc 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:

With admin / own Node.js installation
Without admin / sudo privileges

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

Install locally (no elevated permissions required):

npm install @eigen-ai-labs/eigendata-cli

Verify the installation using npx:

npx eigendata --version

Expected output:

$ npm install @eigen-ai-labs/eigendata-cli
added 1 package in 20s

$ npx eigendata --version
2.2.10

Replace eigendata with npx eigendata in all subsequent commands when using a local installation.

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:

Chatbot Interaction - How you interact with the CLI through natural language
Function Schema - Define the tools available for data generation
Domain & Reference Document - Provide context for your data domain
Core Features - Schema polish, data generate, data repair, and data audit
/configure - Update your settings at any time

Eigen AI

API Reference

Platform

Products

Installation

Supported Platforms

Prerequisites

Configure npm Registry

Install EigenData-CLI

Quick Start

Launch EigenData-CLI

First-Time Setup

Start Using EigenData-CLI

What’s Next

​Installation

​Supported Platforms

​Prerequisites

​Configure npm Registry

​Install EigenData-CLI

​Quick Start

​Launch EigenData-CLI

​First-Time Setup

​Start Using EigenData-CLI

​What’s Next

Installation

Supported Platforms

Prerequisites

Configure npm Registry

Install EigenData-CLI

Quick Start

Launch EigenData-CLI

First-Time Setup

Start Using EigenData-CLI

What’s Next