CLI Overview

pip install openagents

openagents --version
# Output: openagents 0.6.7

openagents <group> <command> [options]

# Launch network and studio together (quickest start)
openagents studio
 
# Start a network from configuration
openagents network start [config_file]
 
# List running networks
openagents network list
 
# Stop a network
openagents network stop [network_name]
 

# One command to launch network + studio
openagents studio
 
# Or launch components separately
openagents network start examples/default_network/network.yaml
openagents studio --port 8700

# Launch studio with custom settings
openagents studio --host localhost --port 8570 --studio-port 8055
 
# Launch without opening browser (headless server)
openagents studio --no-browser
 
# Connect to remote network
openagents studio --host remote.example.com --port 8570

# General help
openagents --help
 
# Group-specific help  
openagents network --help
 
# Command-specific help
openagents network start --help

openagents network start --help

Usage: openagents network start [OPTIONS] [CONFIG_FILE]
 
  Start an OpenAgents network from configuration file.
 
Options:
  --workspace PATH        Path to workspace directory for persistent storage
  --detach               Run network in background
  --runtime SECONDS      Runtime in seconds (default: run indefinitely)
  --host TEXT            Override config host address
  --port INTEGER         Override config port number
  --help                 Show this message and exit.
 
Examples:
  openagents network start config.yaml
  openagents network start --workspace ./my_workspace
  openagents network start config.yaml --detach --runtime 3600

--verbose, -v          Increase verbosity (can be repeated: -vv, -vvv)
--quiet, -q           Suppress non-error output
--config PATH         Path to global config file
--log-level LEVEL     Set logging level (debug, info, warn, error)
--no-color           Disable colored output

# Verbose output for debugging
openagents -vv network start config.yaml
 
# Quiet mode for scripts
openagents -q network list
 
# Custom log level
openagents --log-level debug network start config.yaml

# ~/.openagents/config.yaml
defaults:
  log_level: "info"
  workspace_path: "~/openagents_workspaces"
  
studio:
  default_port: 8055
  auto_open_browser: true
  
network:
  default_host: "localhost"
  default_port: 8570

# my_network.yaml
network:
  name: "development-network"
  description: "Development environment for AI agents"
  
  coordinator:
    type: "centralized"
    host: "localhost"
    port: 8570
    
  protocols:
    - "openagents.mods.communication.simple_messaging"
    - "openagents.mods.discovery.basic_discovery"
    
  workspace:
    enabled: true
    path: "./workspace"
    
  security:
    authentication: false
    rate_limiting: true

# Set default workspace location
export OPENAGENTS_WORKSPACE=/path/to/workspace
 
# Set default log level
export OPENAGENTS_LOG_LEVEL=debug
 
# Disable colored output
export OPENAGENTS_NO_COLOR=1
 
# Set default config file
export OPENAGENTS_CONFIG=/path/to/config.yaml

#!/bin/bash
# start_development_environment.sh
 
# Start multiple networks
openagents network start dev-network.yaml --detach
openagents network start test-network.yaml --detach --port 8571
 
# Wait for networks to be ready
sleep 5
 
# Start monitoring
openagents studio --port 8570 --no-browser &
openagents studio --port 8571 --studio-port 8056 --no-browser &
 
echo "Development environment ready!"

#!/bin/bash
# health_check.sh
 
networks=$(openagents network list --format json)
if [ $? -eq 0 ]; then
    echo "✅ OpenAgents networks healthy"
    exit 0
else
    echo "❌ OpenAgents networks issues detected"
    exit 1
fi

FROM python:3.9-slim
 
RUN pip install openagents
COPY network_config.yaml /app/
WORKDIR /app
 
CMD ["openagents", "network", "start", "network_config.yaml", "--host", "0.0.0.0"]

# /etc/systemd/system/openagents-network.service
[Unit]
Description=OpenAgents Network
After=network.target
 
[Service]
Type=simple
User=openagents
WorkingDirectory=/opt/openagents
ExecStart=/usr/local/bin/openagents network start production.yaml
Restart=always
RestartSec=10
 
[Install]
WantedBy=multi-user.target

apiVersion: apps/v1
kind: Deployment
metadata:
  name: openagents-coordinator
spec:
  replicas: 1
  selector:
    matchLabels:
      app: openagents-coordinator
  template:
    metadata:
      labels:
        app: openagents-coordinator
    spec:
      containers:
      - name: coordinator
        image: openagents:latest
        command: ["openagents", "network", "start", "/config/network.yaml"]
        ports:
        - containerPort: 8570
        volumeMounts:
        - name: config
          mountPath: /config
      volumes:
      - name: config
        configMap:
          name: openagents-config

Error: Port 8570 already in use
Solution: Use --port to specify different port or stop conflicting service

Error: Invalid configuration file: missing 'network.coordinator' section
Solution: Check YAML syntax and ensure all required sections are present

Error: Permission denied creating workspace at ./workspace
Solution: Check directory permissions or use --workspace with writable path

# Maximum verbosity
openagents -vvv network start config.yaml
 
# Debug-level logging
openagents --log-level debug network start config.yaml

# Follow live logs
tail -f ~/.openagents/logs/openagents.log
 
# View network-specific logs
openagents network logs my-network --follow

# Faster parsing in scripts
networks=$(openagents network list --format json)

# Run networks in background for faster startup
openagents network start config.yaml --detach

# Start multiple networks efficiently
for config in configs/*.yaml; do
    openagents network start "$config" --detach
done