Real-World Examples

Practical workflows and integration patterns showing how engineering teams use the Ellygent CLI.

AI-Assisted Development Workflow

Feed AI coding assistants with complete system context instead of isolated prompts

Use Case

Provide requirements and constraints to GitHub Copilot, Cursor, or other AI tools so they generate code that aligns with approved specifications

Context

Development

# Sync complete project context
ellygent context pull --project platform-api --version main

# Context is now available in .ellygent/:
# - requirements/*.md
# - capabilities/*.md
# - traceability.json

# AI tools can now reference:
# - System requirements and constraints
# - Approved capabilities and boundaries
# - Architecture decisions
# - Terminology and glossary

CI/CD Context Injection

Automatically download and validate engineering context in your build pipeline

Use Case

Ensure generated code, tests, and documentation stay aligned with approved requirements and architecture constraints

CI/CD

Automation

Validation

# Set PAT in CI environment
export ELLYGENT_PAT=${SECRET_ELLYGENT_PAT}

# Authenticate
ellygent auth login --api-url https://api.ellygent.com

# Download context
ellygent context pull \
  --project platform-api \
  --version baseline-2.0 \
  --format json \
  --output context.json

# Validate code against requirements
# Parse JSON and check traceability
cat .ellygent/traceability.json | jq '.requirements[]'

Selective Specification Export

Download only the specifications you need for a specific task or analysis

Use Case

Focus on safety requirements for regulatory review, or extract only architectural constraints for design work

Export

Requirements

Filtering

# Export only safety-critical specs
ellygent context pull \
  --project safety-system \
  --version v2.1 \
  --spec functional_requirements \
  --spec safety_requirements \
  --spec hazard_analysis \
  --include-traceability

# Result: .ellygent/ contains only selected specs
# Plus traceability showing links between them

Multi-Project Context Discovery

Explore and compare multiple projects across your organization to find reusable patterns

Use Case

Discover shared components, common requirements, and design patterns across your organization's projects

Discovery

Exploration

Reuse

# List all accessible organizations
ellygent context orgs --format markdown

# Explore projects in an org
ellygent context projects --org automotive --format markdown

# Compare versions across projects
ellygent context versions --project brake-control
ellygent context versions --project steering-control

# View contents to compare specifications
ellygent context inspect --project brake-control --version v1.0
ellygent context inspect --project steering-control --version v1.0

Environment-Specific Configuration

Use different configurations for development, staging, and production environments

Use Case

Maintain separate API endpoints and credentials for each environment without changing scripts

Configuration

Environments

DevOps

# Development environment
export ELLYGENT_API_URL=https://dev.ellygent.com
export ELLYGENT_PAT=${DEV_PAT}
ellygent context pull --project app --version dev-branch

# Staging environment
export ELLYGENT_API_URL=https://staging.ellygent.com
export ELLYGENT_PAT=${STAGING_PAT}
ellygent context pull --project app --version staging

# Production environment
export ELLYGENT_API_URL=https://api.ellygent.com
export ELLYGENT_PAT=${PROD_PAT}
ellygent context pull --project app --version v2.0.0

Automated Documentation Generation

Generate up-to-date engineering documentation from synced context

Use Case

Create technical documentation, architecture decision records, or compliance reports from requirements

Documentation

Compliance

Reporting

# Sync with all optional context
ellygent context pull \
  --project platform-api \
  --version main \
  --include-architecture \
  --include-constraints \
  --include-glossary \
  --include-ai-summaries

# Process markdown files for doc generation
find .ellygent/requirements -name "*.md" -exec cat {} \;

# Extract traceability for compliance reports
cat .ellygent/traceability.json | jq '.requirements[] | select(.category == "safety")'

Offline Development Setup

Download context packages for offline work on restricted networks

Use Case

Work on secure networks, air-gapped systems, or while traveling without reliable connectivity

Offline

Security

Air-gapped

# While connected: sync full context
ellygent context pull \
  --project critical-system \
  --version v3.0 \
  --workspace ~/offline-context/ \
  --include-traceability \
  --include-architecture

# Later, offline: copy context to project
cp -r ~/offline-context/.ellygent ./my-project/

# Work offline with full context available
# AI tools and scripts can access requirements locally

Project-Specific Defaults

Set up project-specific configuration to reduce repetitive command options

Use Case

Streamline workflows when working primarily on one project or organization

Configuration

Productivity

Defaults

# Set organization and project defaults
ellygent config set default-org acme-corp
ellygent config set default-project safety-system

# Now commands are shorter
ellygent context projects  # uses default org
ellygent context versions  # uses default project
ellygent context pull --version v2.1  # uses default project

# Override defaults when needed
ellygent context projects --org other-org

JSON Output for Scripting

Use JSON output for programmatic processing and integration with other tools

Use Case

Build custom automation, dashboards, or integrations using CLI output as structured data

JSON

Scripting

Automation

# Get projects as JSON
ellygent context projects --org acme-corp --format json > projects.json

# Parse with jq
cat projects.json | jq '.[] | {name: .name, id: .alternative_id}'

# Filter and process
cat projects.json | jq '.[] | select(.status == "active")'

# Integrate with scripts
PROJECT_COUNT=$(ellygent context projects --org acme-corp -f json | jq '. | length')
echo "Found $PROJECT_COUNT projects"

Additional Resources

Explore more integration patterns and automation guides:

Previous: Command Reference Next: CI/CD Integration