OACP Docs
v2.0
Getting StartedComponentsAPI ReferenceExamplesGuides
Getting Started
Introduction
Quick Start
Installation
Basic Usage
Core Concepts
Agents
Agent Systems
Voting Strategies
Storage Backends
Adaptive Prompting
Examples
Research Team
Game AI Simulation
Content Pipeline
Code Review
Advanced Topics
Custom Voting Strategies
Custom Storage Backends
Performance Optimization
Deployment
CLI Commands
Overview
Environment Setup
Monitoring
Log Management
Web Dashboard
Advanced Commands

OACP CLI Commands

The OACP Command Line Interface provides comprehensive tools for managing environments, monitoring workflows, and interacting with OACP systems.

Quick Reference

Environment Management

# Setup environment
oacp env setup --global

# Initialize new project  
oacp env init my-project

# Check status
oacp env status

Monitoring & Analysis

# List recent runs
oacp list

# Show statistics
oacp stats

# Show configuration
oacp config

Log Management

# Tail logs for specific run
oacp logs tail --run-id 01K2YT33MGV09DJPQCPN5FE8FE

# Show event timeline
oacp logs timeline --run-id 01K2YT33MGV09DJPQCPN5FE8FE

Web Dashboard

# Start dashboard
oacp serve

# Custom host and port
oacp serve --host 0.0.0.0 --port 8080

# Development mode
oacp serve --reload

Table of Contents

Environment Commands

Setup, initialization, and environment management

Monitoring Commands

System monitoring, statistics, and configuration

Log Management

Log streaming, analysis, and timeline views

Web Dashboard

Start and manage the web interface

Advanced Commands

Replay, debugging, and advanced features

Environment Commands

oacp env setup

Interactive environment setup for OACP projects.

Options:

  • --global - Setup global OACP environment configuration
  • --storage PATH - Custom storage path for logs and data
  • --force - Overwrite existing configuration without prompting

Examples:

# Basic interactive setup
oacp env setup

# Global configuration setup
oacp env setup --global

# Custom storage path
oacp env setup --storage postgresql://user:pass@localhost/oacp

oacp env status

Display current environment status and configuration.

Shows:

  • OACP installation status and version
  • Environment variables status
  • Configuration file locations
  • API key status (masked for security)
  • Active configuration settings

oacp env init

Initialize new OACP projects from templates.

Options:

  • --name NAME - Project name (directory will be created)
  • --template TYPE - Project template (basic, research, multi-agent)

Examples:

# Interactive project creation
oacp env init

# Create research project
oacp env init --name ai-research --template research

Monitoring Commands

oacp list

List recent OACP workflow runs.

Options:

  • --limit, -l NUMBER - Number of runs to display (default: 10)
  • --status STATUS - Filter by run status (completed, failed, running, cancelled)

Examples:

# List last 10 runs
oacp list

# Filter by status
oacp list --status failed

oacp stats

Display statistics and metrics for OACP runs.

Options:

  • --run-id ID - Show detailed stats for specific run
  • --days NUMBER - Show global stats for last N days (default: 7)

Examples:

# Global stats for last 7 days
oacp stats

# Stats for specific run
oacp stats --run-id 01K2YT33MGV09DJPQCPN5FE8FE

oacp config

Display current OACP configuration. Shows storage configuration, logging settings, adaptive prompting settings, and environment variable sources. Sensitive values are masked for security.

Log Management

oacp logs tail

Stream logs for specific OACP runs.

Options:

  • --run-id ID - Run ID to tail (required)
  • --follow, -f - Follow log output in real-time
  • --lines, -n NUMBER - Number of lines to show (default: 50)
  • --type TYPE - Filter by event type (VoteCast, NodeStart, etc.)

Examples:

# Tail logs for specific run
oacp logs tail --run-id 01K2YT33MGV09DJPQCPN5FE8FE

# Follow logs in real-time
oacp logs tail --run-id 01K2YT33MGV09DJPQCPN5FE8FE --follow

# Filter by event type
oacp logs tail --run-id 01K2YT33MGV09DJPQCPN5FE8FE --type VoteCast

oacp logs timeline

Show timeline view of events for a run.

Options:

  • --run-id ID - Run ID to show timeline for (required)
  • --format FORMAT - Output format (table, json)
  • --type TYPE - Filter by event type

Examples:

# Show event timeline
oacp logs timeline --run-id 01K2YT33MGV09DJPQCPN5FE8FE

# Output as JSON
oacp logs timeline --run-id 01K2YT33MGV09DJPQCPN5FE8FE --format json

Web Dashboard

oacp serve

Start the OACP web dashboard and API server.

Options:

  • --host HOST - Host to bind to (default: 127.0.0.1)
  • --port PORT - Port to bind to (default: 8000)
  • --reload - Enable auto-reload for development

Access Points:

  • Dashboard: http://localhost:8000
  • API Docs: http://localhost:8000/docs
  • Health Check: http://localhost:8000/health
  • WebSocket: ws://localhost:8000/ws

Examples:

# Start on default host and port
oacp serve

# Custom host and port
oacp serve --host 0.0.0.0 --port 8080

# Development mode with auto-reload
oacp serve --reload

Advanced Commands

oacp replay

Replay OACP runs for debugging and analysis.

Options:

  • --run-id ID - Run ID to replay (required)
  • --dry-run - Show replay plan without executing
  • --start-from EVENT_ID - Start replay from specific event ID

Examples:

# Show replay plan for a run
oacp replay --run-id 01K2YT33MGV09DJPQCPN5FE8FE --dry-run

# Start replay from specific event
oacp replay --run-id 01K2YT33MGV09DJPQCPN5FE8FE --start-from 01K2YT34ABC123

Getting Help

# General help
oacp --help

# Command-specific help
oacp env --help
oacp logs --help
oacp serve --help

For complete documentation, visit our CLI Reference Guide or check the GitHub repository.