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.3.tar.gz (33.0 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.3-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: open_agent_spec-1.0.3.tar.gz
  • Upload date:
  • Size: 33.0 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.3.tar.gz
Algorithm Hash digest
SHA256 a93a88288a5d30818d53fe1808d7b89eea66d42799d026c7f319e6b79bc27c9d
MD5 bd8264ca2dc2f5a38b227779fd608675
BLAKE2b-256 b02af3f61f171ea6b2725b5105d3fe9cca77eba1ebde473327cd7d07ee03f531

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for open_agent_spec-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5a82ff336c867166d864154156396f0a7453e6cb1b68a1531849242748b48b0b
MD5 f726101b589b103c433eb5dc8a0d8962
BLAKE2b-256 5d2bbf4566650e31b24e6a912cfe55dab6227a9ed7a7a1ed8d30ce926afd0aba

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