OSSA Documentation

Welcome to the complete OSSA documentation. All reference documentation is auto-generated from source code and specifications.

📚 Documentation Sections

[object Object]

Complete reference for all OSSA CLI commands with examples.

Key Commands:

• ossa validate - Validate agent manifests
• ossa generate - Generate agent templates
• ossa run - Run agents locally
• ossa migrate - Migrate between versions
• ossa init - Initialize projects
• ossa setup - Setup environment
• ossa export - Export manifests
• ossa import - Import from frameworks
• ossa schema - View schemas
• ossa gitlab-agent - GitLab integration
• ossa agents - Manage agents

[object Object]

Complete REST API documentation with endpoints, examples, and authentication.

4 Core APIs Documented:

• OSSA Core API - Agent management
• OSSA Registry API - Agent registry
• Unified Agent Gateway - Gateway API

[object Object]

Complete schema documentation explaining why, how, and where to use each field.

Key Fields Documented:

• agent.id - Unique identifier
• agent.name - Human-readable name
• agent.version - Semantic version
• agent.role - Agent classification
• agent.capabilities - What agents can do

🚀 Quick Start

# Install OSSA CLI
npm install -g @bluefly/openstandardagents

# Validate an agent
ossa validate agent.ossa.yaml

# Generate a new agent
ossa generate worker --name "My Agent"

# Run an agent locally
ossa run agent.ossa.yaml

🤖 Auto-Generated Documentation

All reference documentation is automatically generated from:

• CLI Docs: Generated from src/cli/commands/*.ts
• API Docs: Generated from openapi/core/*.yaml
• Schema Docs: Generated from spec/v*/ossa-*.schema.json

Documentation stays in sync with code through:

• GitLab CI/CD pipeline
• Documentation agent (OSSA-compliant)
• Automated validation and deployment

📖 Additional Resources

• Getting Started - Quick start guide
• Architecture - System architecture
• Migration Guides - Framework migrations
• Examples - Real-world examples

🔄 Documentation Updates

Documentation is automatically updated when:

• OpenAPI specifications change
• CLI commands are modified
• JSON Schema is updated

Last Generated: {new Date().toISOString()}

💡 Contributing to Documentation

See our Documentation Implementation Guide for:

• Documentation standards
• Template usage
• Automation setup
• Contributing guidelines

---

Questions? Open an issue on GitLab with the documentation label.