Skip to main content

Open Agent Spec CLI for bootstrapping AI agent projects

Project description

Open Agent Spec (OAS) CLI

A command-line tool for generating agent projects based on Open Agent Spec YAML files.

Installation

pip install open-agent-spec

Usage

Basic Usage

# Show help
oas --help

# Initialize a new agent project
oas init --spec path/to/spec.yaml --output path/to/output

# Preview what would be created without writing files
oas init --spec path/to/spec.yaml --output path/to/output --dry-run

# Enable verbose logging
oas init --spec path/to/spec.yaml --output path/to/output --verbose

Spec File Format

The spec file should be in YAML format with the following structure:

info:
  name: my-agent
  description: A fantastic agent that changes the world

intelligence:
  endpoint: https://api.openai.com/v1
  model: gpt-4
  config:
    temperature: 0.7
    max_tokens: 1000

Generated Project Structure

output/
├── agent.py              # Main agent implementation
├── prompts/             # Prompt templates
│   └── analyst_prompt.jinja2
├── requirements.txt     # Project dependencies
└── .env.example        # Environment variables template

Development

Setup

# Clone the repository
git clone https://github.com/aswhitehouse/open-agent-spec.git
cd oas-cli

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

Running Tests

pytest

Building

python -m build

Pacakge Installation

PyPI version Python versions

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPLv3), which ensures that improvements and deployments of this codebase stay open and benefit the wider community.

If you're a business or enterprise and would like to:

Use this tool in a proprietary or internal-only setting

Avoid open-sourcing your modifications or integrations

Receive custom implementation support or consulting

Discuss a commercial license or enterprise partnership

➡️ Please feel free to reach out: 📧 andrewswhitehouse@gmail.com

Myself and my collaborators would be happy to support your journey with AI agents and ensure responsible, scalable use of this tooling in your stack.

Overview

https://www.openagentstack.ai

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

open_agent_spec-1.0.2.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

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

open_agent_spec-1.0.2-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file open_agent_spec-1.0.2.tar.gz.

File metadata

  • Download URL: open_agent_spec-1.0.2.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.5

File hashes

Hashes for open_agent_spec-1.0.2.tar.gz
Algorithm Hash digest
SHA256 82004af463a57bf10af2faf827442b0e37abf6641b049f6b2ec57c766ad33990
MD5 1c523b7d3b4fbd3523559dd9dd24803a
BLAKE2b-256 b54b829af92084805a908995595740b664e8d24682c10917b0e381a6afe5ae29

See more details on using hashes here.

File details

Details for the file open_agent_spec-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for open_agent_spec-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0c0ddc01f161f9272e4fc33b4b65413ca2bfee433e0d28c4252428e20f4bcb0a
MD5 aaa277dc70b25eee70b819f92bd1796a
BLAKE2b-256 e67e1af3fa6fe5b9cd26c23c9ea5d94042a2fe81cc501ff32e6b3bc20a9e6256

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