Skip to content

Latest commit

 

History

History
1402 lines (975 loc) · 24.7 KB

File metadata and controls

1402 lines (975 loc) · 24.7 KB

Godel CLI Command Reference

Version: v2.0
Last Updated: 2026-02-02

Complete reference for all Godel CLI commands.


Global Options

godel [options] [command]
Option Description
-v, --version Display version number
-h, --help Display help for command

Command Overview

Command Description
team Manage agent teams
dashboard Launch the Godel TUI dashboard
agents Manage AI agents
openclaw Manage OpenClaw Gateway integration
clawhub Manage skills from ClawHub registry
events Stream and list events
quality Code quality checks
reasoning Analyze agent reasoning
tasks Manage tasks
context Manage context
tests Run tests
safety Safety commands
self-improve Run self-improvement cycles
budget Manage budget limits
approve Approval workflow commands
status Show system status

team - Manage Agent Teams

team create

Create a new team of agents.

godel team create --name <name> --task <task> [options]

Options:

Option Description Default
-n, --name <name> (Required) Team name -
-t, --task <task> (Required) Task description -
-i, --initial-agents <count> Initial number of agents 5
-m, --max-agents <count> Maximum number of agents 50
-s, --strategy <strategy> Strategy: parallel, map-reduce, pipeline, tree parallel
--model <model> Model to use kimi-k2.5
-b, --budget <amount> Budget limit (USD) -
--warning-threshold <percentage> Budget warning threshold (0-100) 75
--critical-threshold <percentage> Budget critical threshold (0-100) 90
--sandbox Enable file sandboxing true
--dry-run Show configuration without creating -

Examples:

# Create a basic team
godel team create --name "analysis-team" --task "Analyze user feedback"

# Create with custom settings
godel team create \
  --name "code-review" \
  --task "Review all TypeScript files" \
  --initial-agents 10 \
  --max-agents 100 \
  --strategy map-reduce \
  --budget 50.00

# Preview configuration
godel team create --name "test" --task "test task" --dry-run

team destroy

Destroy a team and all its agents.

godel team destroy <team-id> [options]

Arguments:

Argument Description
team-id Team ID to destroy

Options:

Option Description
-f, --force Force destroy without confirmation
--yes Skip confirmation prompt

Examples:

# Destroy with confirmation prompt
godel team destroy team-abc-123

# Force destroy
godel team destroy team-abc-123 --force --yes

team scale

Scale a team to a target number of agents.

godel team scale <team-id> <target-size>

Arguments:

Argument Description
team-id Team ID to scale
target-size Target number of agents

Examples:

# Scale up to 20 agents
godel team scale team-abc-123 20

# Scale down to 3 agents
godel team scale team-abc-123 3

team status

Get team status.

godel team status [team-id] [options]

Arguments:

Argument Description
team-id Team ID (shows all if omitted)

Options:

Option Description Default
-f, --format <format> Output format: table or json table

Examples:

# Show all teams
godel team status

# Show specific team
godel team status team-abc-123

# Output as JSON
godel team status team-abc-123 --format json

team list

List all teams.

godel team list [options]

Options:

Option Description
-a, --active Show only active teams
-f, --format <format> Output format: table or json

Examples:

# List all teams
godel team list

# List only active teams as JSON
godel team list --active --format json

agents - Manage AI Agents

agents list

List all agents.

godel agents list [options]

Options:

Option Description Default
-f, --format <format> Output format: table or json table
-s, --team <swarmId> Filter by team ID -
--status <status> Filter by status: pending, running, paused, completed, failed, killed -

Examples:

# List all agents
godel agents list

# Filter by team
godel agents list --team team-abc-123

# Filter by status
godel agents list --status running

# Output as JSON
godel agents list --format json

agents spawn

Spawn a new agent.

godel agents spawn <task> [options]

Arguments:

Argument Description
task Task description

Options:

Option Description Default
-m, --model <model> Model to use kimi-k2.5
-l, --label <label> Agent label -
-s, --team <swarmId> Add to existing team -
-p, --parent <parentId> Parent agent ID (for hierarchical spawning) -
-r, --retries <count> Max retry attempts 3
-b, --budget <limit> Budget limit (USD) -
--dry-run Show configuration without spawning -

Examples:

# Spawn a simple agent
godel agents spawn "Review PR #123"

# Spawn with options
godel agents spawn "Analyze codebase" \
  --model claude-sonnet-4-5 \
  --label "code-analyzer" \
  --retries 5 \
  --budget 10.00

# Spawn into a team
godel agents spawn "Sub-task" --team team-abc-123

# Preview configuration
godel agents spawn "test task" --dry-run

agents pause

Pause a running agent.

godel agents pause <agent-id>

Arguments:

Argument Description
agent-id Agent ID to pause

Example:

godel agents pause agent-abc-123

agents resume

Resume a paused agent.

godel agents resume <agent-id>

Arguments:

Argument Description
agent-id Agent ID to resume

Example:

godel agents resume agent-abc-123

agents kill

Kill an agent.

godel agents kill <agent-id> [options]

Arguments:

Argument Description
agent-id Agent ID to kill

Options:

Option Description
-f, --force Force kill without confirmation
--yes Skip confirmation prompt

Examples:

# Kill with confirmation
godel agents kill agent-abc-123

# Force kill
godel agents kill agent-abc-123 --force --yes

agents status

Get detailed agent status.

godel agents status <agent-id> [options]

Arguments:

Argument Description
agent-id Agent ID

Options:

Option Description Default
-f, --format <format> Output format: table or json table
--logs Include recent logs -

Examples:

# Get agent status
godel agents status agent-abc-123

# Get status with logs as JSON
godel agents status agent-abc-123 --logs --format json

agents retry

Manually retry a failed agent.

godel agents retry <agent-id> [options]

Arguments:

Argument Description
agent-id Agent ID to retry

Options:

Option Description
-m, --model <model> Use alternate model for retry
--reset Reset retry count before retrying

Examples:

# Retry with same model
godel agents retry agent-abc-123

# Retry with different model
godel agents retry agent-abc-123 --model gpt-4

# Reset retry count and retry
godel agents retry agent-abc-123 --reset

agents metrics

Show agent lifecycle metrics.

godel agents metrics [options]

Options:

Option Description Default
-f, --format <format> Output format: table or json table

Example:

godel agents metrics
godel agents metrics --format json

openclaw - OpenClaw Gateway Integration

openclaw connect

Connect to OpenClaw Gateway.

godel openclaw connect [options]

Options:

Option Description Default
--host <host> Gateway host 127.0.0.1
--port <port> Gateway port 18789
--token <token> Authentication token (or set OPENCLAW_GATEWAY_TOKEN) -
--mock Use mock client for testing -

Examples:

# Connect to local gateway
godel openclaw connect

# Connect to remote gateway
godel openclaw connect --host 192.168.1.100 --port 18789

# Connect with token
godel openclaw connect --token your-token-here

# Connect in mock mode (testing)
godel openclaw connect --mock

openclaw status

Check OpenClaw Gateway status.

godel openclaw status [options]

Options:

Option Description
--mock Use mock client for testing

Example:

godel openclaw status

openclaw sessions list

List OpenClaw sessions.

godel openclaw sessions list [options]

Options:

Option Description
--active Only show active sessions (last 60 min)
--kind <kind> Filter by session kind: main, group, thread
--mock Use mock client for testing

Examples:

# List all sessions
godel openclaw sessions list

# List only active sessions
godel openclaw sessions list --active

# Filter by kind
godel openclaw sessions list --kind main

openclaw sessions history

View session history/transcript.

godel openclaw sessions history <session-key> [options]

Arguments:

Argument Description
session-key Session key

Options:

Option Description Default
-l, --limit <limit> Number of messages to show 50
--mock Use mock client for testing -

Example:

godel openclaw sessions history session-abc-123 --limit 20

openclaw spawn

Spawn an agent via OpenClaw.

godel openclaw spawn [options]

Options:

Option Description Default
-t, --task <task> (Required) Task description -
-m, --model <model> Model to use kimi-k2.5
-b, --budget <amount> Max budget (USD) 1.00
--sandbox Enable sandbox true
--skills <skills> Additional skills (comma-separated) -
--system-prompt <prompt> System prompt override -
--mock Use mock client for testing -

Examples:

# Spawn a simple agent
godel openclaw spawn --task "Analyze this data"

# Spawn with skills
godel openclaw spawn \
  --task "Build a React component" \
  --skills "typescript,react" \
  --budget 5.00

# Spawn in mock mode
godel openclaw spawn --task "Test task" --mock

openclaw send

Send a message to an OpenClaw agent.

godel openclaw send [options] <message>

Arguments:

Argument Description
message Message to send

Options:

Option Description
-s, --session <sessionKey> (Required) Session key
-a, --attach <file> File attachment
--mock Use mock client for testing

Examples:

# Send a message
godel openclaw send --session session-abc-123 "Process this file"

# Send with attachment
godel openclaw send --session session-abc-123 --attach ./data.csv "Analyze this data"

openclaw kill

Kill an OpenClaw session.

godel openclaw kill <session-key> [options]

Arguments:

Argument Description
session-key Session key to kill

Options:

Option Description
-f, --force Force kill (immediate termination)
--mock Use mock client for testing

Examples:

# Kill a session
godel openclaw kill session-abc-123

# Force kill
godel openclaw kill session-abc-123 --force

clawhub - ClawHub Registry

clawhub search

Search for skills in ClawHub.

godel clawhub search [query] [options]

Options:

Option Description Default
-l, --limit <limit> Maximum results to show 20
--sort <sort> Sort by: relevance, downloads, stars, recent relevance
--tag <tag> Filter by tag (can be used multiple times) -
--author <author> Filter by author -

Examples:

# Search for skills
godel clawhub search "typescript"

# Search with filters
godel clawhub search "web scraping" --tag cli --tag automation --sort downloads

# List top skills
godel clawhub search --limit 50 --sort stars

clawhub install

Install a skill from ClawHub.

godel clawhub install <skill> [options]

Arguments:

Argument Description
skill Skill name/slug to install

Options:

Option Description Default
-v, --version <version> Specific version to install latest
-f, --force Force reinstall if already installed false
--no-deps Skip installing dependencies -
--target-dir <dir> Custom installation directory -

Examples:

# Install a skill
godel clawhub install typescript-linter

# Install specific version
godel clawhub install typescript-linter --version 1.2.3

# Force reinstall
godel clawhub install typescript-linter --force

clawhub list

List installed skills.

godel clawhub list [options]

Options:

Option Description Default
-a, --all Show all skills including inactive false
--json Output as JSON -

Examples:

# List active skills
godel clawhub list

# List all skills
godel clawhub list --all

# Output as JSON
godel clawhub list --json

clawhub uninstall

Uninstall a skill.

godel clawhub uninstall <skill> [options]

Arguments:

Argument Description
skill Skill name/slug to uninstall

Options:

Option Description Default
-y, --yes Skip confirmation false

Examples:

# Uninstall with confirmation
godel clawhub uninstall typescript-linter

# Uninstall without confirmation
godel clawhub uninstall typescript-linter --yes

clawhub info

Show detailed information about a skill.

godel clawhub info <skill> [options]

Arguments:

Argument Description
skill Skill name/slug

Options:

Option Description
--readme Show full README content

Examples:

# Show skill info
godel clawhub info typescript-linter

# Show with README
godel clawhub info typescript-linter --readme

clawhub update

Update installed skills.

godel clawhub update [skill] [options]

Options:

Option Description Default
--all Update all skills false

Examples:

# Update specific skill
godel clawhub update typescript-linter

# Update all skills
godel clawhub update --all

budget - Budget Management

budget set

Set budget limits.

godel budget set [options]

Options:

Option Description
--task <tokens> Set per-task token limit
--cost <dollars> (Required) Set budget cost limit in USD
--daily <tokens> Set daily token limit
--agent <id> Agent ID for agent-level budget
--project <name> (Required for daily) Project name
--reset-hour <hour> UTC hour for daily reset (0-23)

Examples:

# Set project daily budget
godel budget set --project "my-project" --daily 100000 --cost 50.00

# Set task budget
godel budget set --task 10000 --cost 5.00 --agent agent-abc-123

budget status

View current budget status.

godel budget status [options]

Options:

Option Description
--agent <id> Filter by agent ID
--project <name> Filter by project name
--format <format> Output format: table or json

Examples:

# Show all budgets
godel budget status

# Show agent budgets
godel budget status --agent agent-abc-123

# Show project budgets
godel budget status --project "my-project" --format json

budget usage

View budget usage reports.

godel budget usage [options]

Options:

Option Description Default
--project <name> (Required) Project name -
--period <period> Time period: week, month month
--since <duration> Since duration (e.g., "1h", "2d", "1w") -
--format <format> Output format: table or json table

Examples:

# View monthly usage
godel budget usage --project "my-project"

# View weekly usage with duration
godel budget usage --project "my-project" --period week --since 7d

budget alert

Manage budget alerts.

budget alert add

Add a budget alert.

godel budget alert add [options]

Options:

Option Description
--threshold <percent> (Required) Alert threshold percentage
--webhook <url> Webhook URL for notifications
--email <address> Email address for notifications
--sms <number> SMS number for notifications
--project <name> (Required) Project to add alert for

Examples:

# Add webhook alert
godel budget alert add --project "my-project" --threshold 80 --webhook https://hooks.slack.com/...

# Add email alert
godel budget alert add --project "my-project" --threshold 90 --email admin@example.com

budget alert list

List configured alerts.

godel budget alert list [options]

Options:

Option Description
--project <name> Filter by project
--format <format> Output format: table or json

Example:

godel budget alert list --project "my-project"

budget alert remove

Remove a budget alert.

godel budget alert remove <id> [options]

Arguments:

Argument Description
id Alert ID to remove

Options:

Option Description
--project <name> (Required) Project the alert belongs to

Example:

godel budget alert remove alert-abc-123 --project "my-project"

budget history

View budget history.

godel budget history [options]

Options:

Option Description Default
--project <name> (Required) Project name -
--since <duration> Since duration 7d
--format <format> Output format: table or json table

Example:

godel budget history --project "my-project" --since 30d

budget report

Generate budget reports.

godel budget report [options]

Options:

Option Description Default
--project <name> (Required) Project to report on -
--period <period> Report period: week, month month
--format <format> Output format: json or table table

Example:

godel budget report --project "my-project" --period month

budget blocked

Manage blocked agents.

budget blocked list

List blocked agents.

godel budget blocked list [options]

Options:

Option Description Default
--format <format> Output format: table or json table

Example:

godel budget blocked list

budget blocked unblock

Unblock an agent.

godel budget blocked unblock <agent-id>

Example:

godel budget blocked unblock agent-abc-123

budget dashboard

Show budget dashboard.

godel budget dashboard [options]

Options:

Option Description
--project <name> Project to focus on

Example:

godel budget dashboard --project "my-project"

quality - Code Quality

quality lint

Run linter.

godel quality lint [options]

Options:

Option Description Default
--fix Automatically fix issues false
--strict Fail on warnings false

Examples:

godel quality lint
godel quality lint --fix
godel quality lint --strict

quality types

Run TypeScript type checking.

godel quality types [options]

Options:

Option Description Default
--strict Enable strict mode false

Example:

godel quality types --strict

quality security

Run security audit.

godel quality security

quality gate

Run all quality checks (lint + types + security).

godel quality gate [options]

Options:

Option Description Default
--strict Fail on warnings false

Example:

godel quality gate --strict

quality status

Show quality status summary.

godel quality status

reasoning - Reasoning Analysis

reasoning trace

Show reasoning traces.

godel reasoning trace <agent-id> [options]

Arguments:

Argument Description
agent-id Agent ID

Options:

Option Description Default
-t, --type <type> Filter by trace type -
-l, --limit <n> Limit results 10

Example:

godel reasoning trace agent-abc-123 --limit 20

reasoning decisions

Show decision log.

godel reasoning decisions <agent-id> [options]

Arguments:

Argument Description
agent-id Agent ID

Options:

Option Description Default
-f, --format <format> Output format table

Example:

godel reasoning decisions agent-abc-123

reasoning analyze

Analyze reasoning patterns.

godel reasoning analyze <agent-id> [options]

Arguments:

Argument Description
agent-id Agent ID

Options:

Option Description
--confidence Check confidence alignment

Example:

godel reasoning analyze agent-abc-123 --confidence

reasoning summarize

Summarize reasoning for a task.

godel reasoning summarize <task-id>

Example:

godel reasoning summarize task-abc-123

self-improve - Self Improvement

self-improve run

Run self-improvement cycle.

godel self-improve run [options]

Options:

Option Description Default
--area <area> Specific area: codeQuality, documentation, testing all
--iterations <n> Number of iterations 1

Examples:

# Run all improvements
godel self-improve run

# Focus on documentation
godel self-improve run --area documentation

# Multiple iterations
godel self-improve run --iterations 3

self-improve status

Check self-improvement status.

godel self-improve status

self-improve report

Generate self-improvement report.

godel self-improve report

status - System Status

Show Godel system status and overview.

godel status [options]

Options:

Option Description Default
-f, --format <format> Output format: table or json table

Example:

godel status
godel status --format json

Environment Variables

Variable Description
OPENCLAW_GATEWAY_TOKEN Authentication token for OpenClaw Gateway
GODEL_API_KEY API key for Godel API server

Exit Codes

Code Meaning
0 Success
1 General error
2 Invalid arguments / Not found
3 Command execution failed