Skip to main content

Engine Framework CLI - Command Line Interface for AI Agent Orchestration

Project description

Engine CLI

PyPI version Python versions License Tests

Engine Framework CLI - Command Line Interface for AI Agent Orchestration System

A powerful terminal interface for managing AI agents, teams, workflows, and orchestration systems. Built on top of the Engine Core framework with rich terminal UI and comprehensive command coverage.

✨ Features

  • 🧠 Agent Management: Create, configure, and manage AI agents from command line
  • 👥 Team Coordination: Build and manage agent teams with advanced coordination strategies
  • ⚡ Workflow Execution: Run Pregel-based workflows with real-time monitoring
  • 🔧 Tool Integration: Manage external integrations (APIs, CLI tools, MCP)
  • 📋 Protocol System: Configure agent behavior protocols and commands
  • 📚 Memory Management: Hierarchical memory system with semantic search
  • 🎨 Rich Terminal UI: Beautiful, interactive command-line interface with colors and tables
  • 🚀 Production Ready: Comprehensive error handling and validation
  • ⚡ Performance Optimized: < 2s startup time with lazy loading and smart caching

📦 Installation

🚀 Quick Install (Recommended)

pip install engine-cli

That's it! Engine CLI v1.0.0 is now available on PyPI and ready to use.

📋 Requirements

  • Python: 3.11 or higher
  • Engine Core: Automatically installed as dependency
  • Optional: Rich terminal for enhanced UI (automatically included)

🔧 Alternative Installation Methods

# From source (development)
git clone https://github.com/engine-agi/engine-cli.git
cd engine-cli
pip install -e .

# With development dependencies
pip install -e ".[dev]"

📚 Documentation

📖 Complete CLI Manual

For comprehensive documentation including all commands, examples, and troubleshooting:

🚀 Quick Examples

# Get started quickly
engine --help

# Create and manage agents
engine agent create --name "code-reviewer" --model "claude-3.5-sonnet"
engine agent list

# Work with teams and workflows
engine team create --name "dev-team"
engine workflow run --id "my-workflow"

# Monitor system status
engine status
engine advanced monitor

🔧 Troubleshooting

Common issues and solutions:

# Enable verbose output for debugging
engine --verbose [command]

# Check configuration
engine config show

# View system status
engine status

# Get detailed help
engine [command] --help

For detailed troubleshooting guides, see the Troubleshooting Guide.

Features

  • Agent Management: Create, configure, and manage AI agents
  • Team Coordination: Build and manage agent teams with different coordination strategies
  • Workflow Execution: Run Pregel-based workflows with real-time monitoring
  • Tool Integration: Manage external tool integrations (APIs, CLI tools, MCP)
  • Protocol System: Configure agent behavior protocols
  • Memory System: Manage hierarchical memory with semantic search
  • Rich Terminal UI: Beautiful, interactive command-line interface

🛠️ Development

This package depends on engine-core for the core framework functionality.

📋 Development Setup

# Clone the repository
git clone https://github.com/engine-agi/engine-cli.git
cd engine-cli

# Install in development mode
pip install -e ".[dev]"

# Install pre-commit hooks (recommended)
pre-commit install

🔧 Pre-commit Hooks

This project uses pre-commit to ensure code quality and consistency. The following hooks are automatically configured:

  • Black: Code formatting (88 character line length)
  • isort: Import sorting with Black profile
  • Trailing Whitespace: Removes trailing whitespace
  • End of File: Ensures files end with a newline
  • Large Files: Prevents accidentally committing large files

The hooks run automatically on every commit. If they fail, your commit will be blocked until the issues are fixed.

To run hooks manually on all files:

pre-commit run --all-files

To run hooks on staged files only:

pre-commit run

🧪 Testing

# Run all tests
pytest

# Run with coverage
pytest --cov=engine_cli --cov-report=html

# Run specific test file
pytest tests/unit/test_agent.py

# Run integration tests
pytest tests/integration/

📦 Building

# Build package
poetry build

# Or with pip
python -m build

📄 License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

📋 Dual Licensing

Engine Framework uses a dual licensing model:

  • AGPL-3.0: For open-source usage, community contributions, and non-commercial projects
  • Commercial License: For enterprise deployments, proprietary integrations, and commercial products

📞 Commercial Licensing

For commercial usage or if you need a different license:

See the LICENSE file and LICENSE-COMMERCIAL for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

engine_cli-1.1.0.tar.gz (70.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

engine_cli-1.1.0-py3-none-any.whl (82.6 kB view details)

Uploaded Python 3

File details

Details for the file engine_cli-1.1.0.tar.gz.

File metadata

  • Download URL: engine_cli-1.1.0.tar.gz
  • Upload date:
  • Size: 70.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.13 Linux/6.11.0-1018-azure

File hashes

Hashes for engine_cli-1.1.0.tar.gz
Algorithm Hash digest
SHA256 7c42689653924637687c973153ba2e3b700b3eb00d1ebfe0cc4c9feacd6d59f9
MD5 a57554444f4db6a6330a9e9e38d3fb39
BLAKE2b-256 7061416206b13e61f24a7bfccf1adc9c043f31f3792f662b808d1b622dad30ea

See more details on using hashes here.

File details

Details for the file engine_cli-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: engine_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 82.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.13 Linux/6.11.0-1018-azure

File hashes

Hashes for engine_cli-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ad626287e4a4c91fc3e7b8a85a8f0455a7f1e05a1f1f339e67d85264f0054fd
MD5 281c0f5d87feebb571dd87eb7eb45e87
BLAKE2b-256 d8ae1a260dc509c1cc4ac06514cbc27fc997f92dab526112783d79c6f01d062e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page