Getting Started

Install the Ellygent CLI and start downloading AI-ready engineering context in under 5 minutes.

Prerequisites

Node.js 18 or higher

Check your version with node --version

An active Ellygent account

Access to at least one organization/project

Ask your organization admin to invite you if needed

Interactive Quickstart

Follow this complete workflow from installation to your first context download:

Terminal

#Install the CLI globally

$npm install -g @ellygent/cli

#Verify installation

$ellygent --version

1.0.0

#Login to Ellygent

$ellygent login

? Ellygent API URL: https://api.ellygent.com

? Email: john.doe@example.com

? Password: ********

✓ Logged in successfully

#Discover your projects

$ellygent projects --org acme-corp --format markdown

┌─────────────────────┬───────────────────┬──────────────┐

│ Project │ Latest Version │ Specs │

├─────────────────────┼───────────────────┼──────────────┤

│ safety-system │ v2.1 │ 12 │

│ platform-api │ main │ 8 │

└─────────────────────┴───────────────────┴──────────────┘

#Download engineering context

$ellygent sync --project safety-system --version v2.1

⬇ Downloading context package...

✓ Extracted to ./.ellygent/

• 247 requirements

• 89 capabilities

• Full traceability graph

Step-by-Step Guide

1. Install the CLI

Install globally using npm:

npm install -g @ellygent/cli

For other installation methods (installer scripts, direct downloads, standalone binaries), see the Installation Guide.

2. Verify Installation

Confirm the CLI is installed and accessible:

ellygent --version

3. Authenticate

ellygent auth login

For CI/CD and automation, use Personal Access Tokens instead. See the Authentication Guide.

4. Discover Your Projects

List projects in your organization:

ellygent context projects --org <your-org-name> --format markdown

Replace <your-org-name> with your organization slug.

5. Download Engineering Context

Sync a project to your local workspace:

ellygent sync --project <project-id> --version <version>

This creates a .ellygent/ directory with requirements, capabilities, and traceability data.

What You Get

After running ellygent sync, your workspace contains:

.ellygent/
├── requirements/
│   ├── functional_requirements.md
│   ├── safety_requirements.md
│   └── performance_requirements.md
├── capabilities/
│   ├── system_capabilities.md
│   └── feature_capabilities.md
├── metadata.json
└── traceability.json

All files are AI-ready markdown and JSON formats, optimized for code generation tools and LLMs.

Next Steps

Explore all CLI commands Set up Personal Access Tokens for automation View real-world workflow examples Integrate with CI/CD pipelines

Back to CLI Home Next: Installation