Getting Started
Install the Ellygent CLI from the command line and start downloading AI-ready engineering context in under 5 minutes.
Prerequisites
Node.js LTS and npm
The official Windows installer now uses npm to install the CLI from GitHub. Check with node --version and npm --version before you begin.
An active Ellygent account
Sign up at ellygent.com
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:
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.
Step-by-Step Guide
1. Install the CLI
Check out the CLI from GitHub, or use the hosted installer wrapper for PowerShell:
# PowerShell wrapper
irm https://ellygent.com/cli/install.ps1 | iex
# Manual GitHub checkout
git clone --depth 1 https://github.com/EEQuality/ellygent-cli.git
Set-Location ellygent-cli
npm install
npm run build
npm install -g .For command-line installation details and troubleshooting, see the Installation Guide.
2. Verify Installation
Confirm the CLI is installed and accessible:
ellygent --help
ellygent --version3. Authenticate
Validate your Personal Access Token and store it for CLI use:
ellygent auth login --token <your-personal-access-token>
ellygent whoami4. Discover Your Projects
List projects in your organization:
ellygent context projects --org <your-org-name> --format markdownReplace <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/
├── manifest.json # Project, version and export metadata
├── project-summary.md
├── system-definition.md # Selected system-definition content
├── relations.json # Relations between exported objects
├── requirements/
│ └── <specification>.md # Filenames depend on your selection
├── traceability/
│ └── relationships.json # With --include-traceability
└── constraints/
└── constraints.json # With --include-constraintsThe package includes Markdown documents and JSON metadata. Supply selected files to a coding assistant and review its output. Optional files depend on export flags; recorded assumptions and open questions travel with their source content.