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.

# Install in development mode
poetry install

# Run tests
poetry run pytest

# Build package
poetry 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.0.1.tar.gz (34.9 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.0.1-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: engine_cli-1.0.1.tar.gz
  • Upload date:
  • Size: 34.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for engine_cli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 02ab459b417d51c6c98826ea12499b6be160873e7806161d46b6f59d3179f726
MD5 85a923e9b86b8c7e61ab2f8d75cc3989
BLAKE2b-256 767dd63f3b8d1731eb77bddc2f24b6f27ebd7faf410dcc35c07f5fa3b0d5f160

See more details on using hashes here.

File details

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

File metadata

  • Download URL: engine_cli-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 42.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for engine_cli-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ee7070967f4047b3412fee87e594e3322aa828acbf5634902b96acb8c2dd86a2
MD5 6f603502412876536bdfa4b0a0040daa
BLAKE2b-256 e834336770ad5baaabb608a301e0a3e603ef0fd49f8fd4d5077dabedd4f87dee

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