@bluefly/openstandardagents 0.2.4 → 0.2.7

package/website/content/docs/cli-reference/index.md

@@ -0,0 +1,111 @@
+# CLI Reference
+
+The OSSA CLI provides commands for managing AI agents throughout their lifecycle.
+
+## Installation
+
+```bash
+npm install -g @bluefly/openstandardagents
+```
+
+## Quick Start
+
+```bash
+# Validate an agent manifest
+ossa validate agent.ossa.yaml
+
+# Generate a new agent
+ossa generate worker --name "My Agent"
+
+# Run an agent locally
+ossa run agent.ossa.yaml
+```
+
+## Commands
+
+### [ossa validate](./ossa-validate.md)
+
+Validate OSSA agent manifests against the schema
+
+### [ossa generate](./ossa-generate.md)
+
+Generate OSSA agent manifests from templates
+
+### [ossa migrate](./ossa-migrate.md)
+
+Migrate agent manifests between OSSA versions
+
+### [ossa run](./ossa-run.md)
+
+Run an OSSA agent locally
+
+### [ossa init](./ossa-init.md)
+
+Initialize a new OSSA project
+
+### [ossa setup](./ossa-setup.md)
+
+Set up OSSA development environment
+
+### [ossa export](./ossa-export.md)
+
+Export agent manifest to different formats
+
+### [ossa import](./ossa-import.md)
+
+Import agents from other frameworks
+
+### [ossa schema](./ossa-schema.md)
+
+View and manage OSSA schemas
+
+### [ossa gitlab-agent](./ossa-gitlab-agent.md)
+
+Manage GitLab agent integration
+
+### [ossa agents](./ossa-agents.md)
+
+Manage OSSA agents
+
+
+## Global Options
+
+- `--help` - Show help for any command
+- `--version` - Show OSSA CLI version
+- `--config <path>` - Path to config file
+- `--verbose` - Enable verbose logging
+- `--quiet` - Suppress output
+
+## Configuration
+
+The OSSA CLI can be configured via:
+
+1. **Config file**: `.ossarc.json` or `.ossarc.yaml`
+2. **Environment variables**: `OSSA_*`
+3. **Command-line flags**
+
+Example `.ossarc.json`:
+
+```json
+{
+  "registry": "https://registry.ossa.dev",
+  "defaultVersion": "0.2.5-RC",
+  "validation": {
+    "strict": true
+  }
+}
+```
+
+## Environment Variables
+
+- `OSSA_REGISTRY` - Agent registry URL
+- `OSSA_API_KEY` - API authentication key
+- `OSSA_VERSION` - Default OSSA version
+- `OSSA_DEBUG` - Enable debug mode
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)
+- [Guides](../guides/index.md)

package/website/content/docs/cli-reference/ossa-agents.md

@@ -0,0 +1,70 @@
+# ossa agents
+
+**Purpose**: Manage OSSA agents
+
+## Synopsis
+
+```bash
+ossa agents <action> [options]
+```
+
+## Description
+
+Manage OSSA agents
+
+## Arguments
+
+- `<action>` (required) - Action: list, get, create, update, delete
+
+## Options
+
+- `--id <id>` - Agent ID
+- `--role <role>` - Filter by role
+- `--status <status>` - Filter by status
+- `--format <format>` - Output format: json, yaml, table (default: table)
+
+## Examples
+
+```bash
+ossa agents list
+```
+
+```bash
+ossa agents list --role worker
+```
+
+```bash
+ossa agents get --id my-agent
+```
+
+```bash
+ossa agents create agent.ossa.yaml
+```
+
+```bash
+ossa agents delete --id my-agent
+```
+
+## API Endpoint Connection
+
+This command uses the following API endpoint:
+- `GET /api/v1/agents` - [API Reference](../api-reference/index.md)
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa migrate](./ossa-migrate.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-export.md

@@ -0,0 +1,56 @@
+# ossa export
+
+**Purpose**: Export agent manifest to different formats
+
+## Synopsis
+
+```bash
+ossa export <manifest> [options]
+```
+
+## Description
+
+Export agent manifest to different formats
+
+## Arguments
+
+- `<manifest>` (required) - Path to agent manifest
+
+## Options
+
+- `--format <format>` - Export format: json, yaml, openapi, k8s (default: json)
+- `--output <path>` - Output file path
+- `--pretty` - Pretty print output
+
+## Examples
+
+```bash
+ossa export agent.ossa.yaml --format json
+```
+
+```bash
+ossa export agent.ossa.yaml --format k8s --output deployment.yaml
+```
+
+```bash
+ossa export agent.ossa.yaml --format openapi --pretty
+```
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa migrate](./ossa-migrate.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-generate.md

@@ -0,0 +1,66 @@
+# ossa generate
+
+**Purpose**: Generate OSSA agent manifests from templates
+
+## Synopsis
+
+```bash
+ossa generate <type> [options]
+```
+
+## Description
+
+Generate OSSA agent manifests from templates
+
+## Arguments
+
+- `<type>` (required) - Agent type: worker, orchestrator, compliance, chat
+
+## Options
+
+- `--name <name>` - Agent name (default: My Agent)
+- `--id <id>` - Agent ID (DNS-1123 format)
+- `--output <path>` - Output file path (default: agent.ossa.yaml)
+- `--interactive` - Interactive mode with prompts
+
+## Examples
+
+```bash
+ossa generate worker --name "Data Processor"
+```
+
+```bash
+ossa generate orchestrator --id my-orchestrator
+```
+
+```bash
+ossa generate compliance --interactive
+```
+
+```bash
+ossa generate chat --output chat-agent.yaml
+```
+
+## API Endpoint Connection
+
+This command uses the following API endpoint:
+- `POST /api/v1/agents/generate` - [API Reference](../api-reference/index.md)
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa migrate](./ossa-migrate.md)
+- [ossa run](./ossa-run.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-gitlab-agent.md

@@ -0,0 +1,57 @@
+# ossa gitlab-agent
+
+**Purpose**: Manage GitLab agent integration
+
+## Synopsis
+
+```bash
+ossa gitlab-agent [options]
+```
+
+## Description
+
+Manage GitLab agent integration
+
+## Options
+
+- `--configure` - Configure GitLab agent
+- `--deploy` - Deploy agent to GitLab
+- `--status` - Check agent status
+- `--logs` - View agent logs
+
+## Examples
+
+```bash
+ossa gitlab-agent --configure
+```
+
+```bash
+ossa gitlab-agent --deploy
+```
+
+```bash
+ossa gitlab-agent --status
+```
+
+```bash
+ossa gitlab-agent --logs
+```
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa migrate](./ossa-migrate.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-import.md

@@ -0,0 +1,56 @@
+# ossa import
+
+**Purpose**: Import agents from other frameworks
+
+## Synopsis
+
+```bash
+ossa import <source> [options]
+```
+
+## Description
+
+Import agents from other frameworks
+
+## Arguments
+
+- `<source>` (required) - Source file or URL
+
+## Options
+
+- `--from <framework>` - Source framework: langchain, crewai, openai, mcp
+- `--output <path>` - Output file path (default: agent.ossa.yaml)
+- `--validate` - Validate after import
+
+## Examples
+
+```bash
+ossa import langchain-agent.py --from langchain
+```
+
+```bash
+ossa import crew.yaml --from crewai --validate
+```
+
+```bash
+ossa import https://example.com/agent.json --from openai
+```
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa migrate](./ossa-migrate.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-init.md

@@ -0,0 +1,57 @@
+# ossa init
+
+**Purpose**: Initialize a new OSSA project
+
+## Synopsis
+
+```bash
+ossa init [options]
+```
+
+## Description
+
+Initialize a new OSSA project
+
+## Options
+
+- `--name <name>` - Project name
+- `--template <template>` - Project template: minimal, full, enterprise
+- `--typescript` - Use TypeScript
+- `--git` - Initialize git repository
+
+## Examples
+
+```bash
+ossa init
+```
+
+```bash
+ossa init --name my-agent-project
+```
+
+```bash
+ossa init --template enterprise --typescript
+```
+
+```bash
+ossa init --git
+```
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa migrate](./ossa-migrate.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-migrate.md

@@ -0,0 +1,62 @@
+# ossa migrate
+
+**Purpose**: Migrate agent manifests between OSSA versions
+
+## Synopsis
+
+```bash
+ossa migrate <source> [options]
+```
+
+## Description
+
+Migrate agent manifests between OSSA versions
+
+## Arguments
+
+- `<source>` (required) - Source manifest file
+
+## Options
+
+- `--from <version>` - Source OSSA version
+- `--to <version>` - Target OSSA version (default: latest)
+- `--output <path>` - Output file path
+- `--dry-run` - Show changes without writing
+
+## Examples
+
+```bash
+ossa migrate agent.yaml --from 0.2.4 --to 0.2.5
+```
+
+```bash
+ossa migrate agent.yaml --dry-run
+```
+
+```bash
+ossa migrate agent.yaml --output migrated-agent.yaml
+```
+
+## API Endpoint Connection
+
+This command uses the following API endpoint:
+- `POST /api/v1/migrate` - [API Reference](../api-reference/index.md)
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa run](./ossa-run.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-run.md

@@ -0,0 +1,66 @@
+# ossa run
+
+**Purpose**: Run an OSSA agent locally
+
+## Synopsis
+
+```bash
+ossa run <manifest> [options]
+```
+
+## Description
+
+Run an OSSA agent locally
+
+## Arguments
+
+- `<manifest>` (required) - Path to agent manifest
+
+## Options
+
+- `--env <file>` - Environment variables file
+- `--port <port>` - Port to run on (default: 3000)
+- `--watch` - Watch for changes and reload
+- `--debug` - Enable debug logging
+
+## Examples
+
+```bash
+ossa run agent.ossa.yaml
+```
+
+```bash
+ossa run agent.ossa.yaml --port 8080
+```
+
+```bash
+ossa run agent.ossa.yaml --watch --debug
+```
+
+```bash
+ossa run agent.ossa.yaml --env .env.local
+```
+
+## API Endpoint Connection
+
+This command uses the following API endpoint:
+- `POST /api/v1/agents/{id}/execute` - [API Reference](../api-reference/index.md)
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa migrate](./ossa-migrate.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-schema.md

@@ -0,0 +1,57 @@
+# ossa schema
+
+**Purpose**: View and manage OSSA schemas
+
+## Synopsis
+
+```bash
+ossa schema [options]
+```
+
+## Description
+
+View and manage OSSA schemas
+
+## Options
+
+- `--version <version>` - Schema version (default: latest)
+- `--format <format>` - Output format: json, yaml (default: yaml)
+- `--field <field>` - Show specific field documentation
+- `--list` - List available schema versions
+
+## Examples
+
+```bash
+ossa schema
+```
+
+```bash
+ossa schema --version 0.2.5
+```
+
+```bash
+ossa schema --field agent.id
+```
+
+```bash
+ossa schema --list
+```
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa migrate](./ossa-migrate.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)

package/website/content/docs/cli-reference/ossa-setup.md

@@ -0,0 +1,57 @@
+# ossa setup
+
+**Purpose**: Set up OSSA development environment
+
+## Synopsis
+
+```bash
+ossa setup [options]
+```
+
+## Description
+
+Set up OSSA development environment
+
+## Options
+
+- `--gitlab` - Configure GitLab integration
+- `--kubernetes` - Configure Kubernetes deployment
+- `--registry <url>` - Configure agent registry
+- `--interactive` - Interactive setup wizard
+
+## Examples
+
+```bash
+ossa setup --interactive
+```
+
+```bash
+ossa setup --gitlab
+```
+
+```bash
+ossa setup --kubernetes
+```
+
+```bash
+ossa setup --registry https://registry.ossa.dev
+```
+
+## Exit Codes
+
+- `0` - Success
+- `1` - General error
+- `2` - Invalid arguments
+- `3` - File not found
+
+## Related Commands
+
+- [ossa validate](./ossa-validate.md)
+- [ossa generate](./ossa-generate.md)
+- [ossa migrate](./ossa-migrate.md)
+
+## Related Documentation
+
+- [API Reference](../api-reference/index.md)
+- [Schema Reference](../schema-reference/index.md)
+- [Getting Started](../getting-started/index.md)