Command Reference
Complete reference for all Ellygent CLI commands and options.
Command Groups
Ellygent CLI uses grouped commands for better organization:
ellygent auth
Authentication and credential management
ellygent context
Discover and download engineering context
ellygent config
Manage CLI configuration and defaults
ellygent completion
Generate shell completion scripts
Global Flags
These flags work with all commands:
--help, -h
Display help information for a command.
ellygent --help--version, -v
Display the CLI version.
ellygent --version--format, -f
Output format: json (default) or markdown/md
ellygent projects --format markdownAuthentication Commands
Manage authentication and credentials with ellygent auth.
ellygent auth login
Authenticate with Ellygent and store tokens for subsequent commands.
Options
--api-url <url>— Ellygent API base URL--email <email>— User email address--pat <token>— Personal Access Token (alternative to email/password)
Examples
# Interactive login
ellygent auth login
# Non-interactive with email
ELLYGENT_PASSWORD='...' ellygent auth login \
--api-url https://api.ellygent.com \
--email dev@example.com
# With Personal Access Token
export ELLYGENT_PAT='elly_pat_xxxxxxxxxxxxxxxxxxxxx'
ellygent auth login --api-url https://api.ellygent.comellygent auth logout
Clear stored credentials from local configuration.
Examples
ellygent auth logoutellygent auth status
Check authentication status and view current user information.
Examples
# Check auth status
ellygent auth status
# JSON output
ellygent auth status --jsonContext Commands
Discover and download engineering context with ellygent context.
ellygent context orgs
List organizations you have access to.
Examples
# JSON output (default)
ellygent context orgs
# Markdown table
ellygent context orgs --format markdownellygent context projects
List projects within an organization.
Options
--org <identifier>— Organization identifier (optional if default-org is set)
Examples
# List projects in organization
ellygent context projects --org acme-corp
# Using default org from config
ellygent config set default-org acme-corp
ellygent context projectsellygent context versions
List available versions (live and baselines) for a project.
Options
--project <identifier>— Project identifier (optional if default-project is set)
Examples
# List versions
ellygent context versions --project safety-system
# Using default project from config
ellygent config set default-project safety-system
ellygent context versionsellygent context inspect
Preview specifications and metadata for a specific project version before downloading.
Options
--project <identifier>— Project identifier (required)--version <identifier>— Version identifier (default:main)
Examples
# Inspect latest version
ellygent context inspect --project safety-system
# Inspect specific baseline
ellygent context inspect --project safety-system --version baseline-1.2.0ellygent context pull
Download AI-optimized engineering context package to local workspace.
Options
--project <identifier>— Project identifier (required)--version <identifier>— Version identifier (default:main)--workspace <path>— Target workspace directory (default: current directory)--spec <identifier>— Include specific specification (repeatable)--system-definition <identifier>— Include specific system definition (repeatable)--include-traceability— Include traceability mappings--include-architecture— Include architecture/system-definition context--include-constraints— Include design constraints--include-glossary— Include terminology glossary--include-ai-summaries— Include AI-generated summaries
Examples
# Basic pull to current directory
ellygent context pull --project safety-system
# Pull specific baseline
ellygent context pull --project safety-system --version baseline-1.2.0
# Pull to custom directory
ellygent context pull --project safety-system --workspace ./context/
# Pull with traceability
ellygent context pull --project safety-system --include-traceability
# Pull specific specifications only
ellygent context pull \
--project safety-system \
--spec functional_requirements \
--spec safety_requirements
# Full context with all optional data
ellygent context pull \
--project safety-system \
--include-traceability \
--include-architecture \
--include-constraints \
--include-glossary \
--include-ai-summariesConfiguration Commands
Manage CLI configuration with ellygent config.
ellygent config list
View current CLI configuration.
Examples
# View current config (default action)
ellygent config
ellygent config listellygent config get
Get a specific configuration value.
Examples
# Get specific config value
ellygent config get api-url
ellygent config get default-orgellygent config set
Set a configuration value.
Config Keys
api-url— Ellygent API base URLdefault-org— Default organization identifierdefault-project— Default project identifier
Examples
# Set API URL
ellygent config set api-url https://api.ellygent.com
# Set default organization
ellygent config set default-org acme-corp
# Set default project
ellygent config set default-project safety-systemellygent config reset
Reset all configuration to defaults (clears stored credentials).
Examples
ellygent config resetShell Completion
Generate shell completion scripts with ellygent completion.
ellygent completion
Generate shell completion script for bash, zsh, or fish.
Options
--shell <shell>— Shell type:bash,zsh, orfish
Examples
# Bash
ellygent completion --shell bash > /etc/bash_completion.d/ellygent
# Zsh
ellygent completion --shell zsh > ~/.zsh/completion/_ellygent
# Fish
ellygent completion --shell fish > ~/.config/fish/completions/ellygent.fish