SwiftClaw
Introduction to SwiftClawQuick StartInstallationConfiguration

Authentication

Authentication OverviewAPI KeysWebhooks

API Reference

API OverviewREST APISDK Reference

Core Concepts

Understanding AgentsWorkspacesEnvironments

CLI

CLI ReferenceCLI CommandsCLI Configuration
SwiftClaw

CLI Commands

Complete reference for SwiftClaw CLI commands

CLI Commands

Complete reference for all SwiftClaw CLI commands.

Global Options

Available for all commands:

--help, -h          Show help
--version, -v       Show version
--workspace, -w     Specify workspace
--env, -e           Specify environment
--verbose           Enable verbose output
--quiet, -q         Suppress output

Agents

create

Create a new agent:

swiftclaw agents create <name> [options]

Options:
  --model <model>           AI model (default: gpt-4)
  --memory <type>           Memory type (persistent|ephemeral)
  --workspace <path>        Workspace directory

list

List all agents:

swiftclaw agents list [options]

Options:
  --limit <n>              Number of results
  --offset <n>             Pagination offset
  --sort <field>           Sort field

status

Check agent status:

swiftclaw agents status <agent>

Options:
  --watch, -w              Watch for changes

delete

Delete an agent:

swiftclaw agents delete <agent>

Options:
  --force, -f              Skip confirmation

Deploy

deploy

Deploy agent to environment:

swiftclaw deploy <agent> [options]

Options:
  --env <env>              Environment (development|staging|production)
  --version <version>      Version tag
  --config <file>          Configuration file
  --wait                   Wait for deployment to complete

rollback

Rollback to previous version:

swiftclaw rollback <agent> [options]

Options:
  --version <version>      Specific version to rollback to
  --env <env>              Environment

Logs

logs

View agent logs:

swiftclaw logs <agent> [options]

Options:
  --follow, -f             Follow log output
  --tail <n>               Number of lines to show
  --level <level>          Filter by level (debug|info|warn|error)
  --filter <pattern>       Filter by pattern
  --since <time>           Show logs since time

Metrics

metrics

View agent metrics:

swiftclaw metrics <agent> [options]

Options:
  --metric <name>          Metric name
  --period <duration>      Time period (1h|24h|7d|30d)
  --live                   Live metrics

Keys

keys create

Create API key:

swiftclaw keys create <agent> [options]

Options:
  --name <name>            Key name
  --permissions <perms>    Permissions (read|write|delete)
  --length <n>             Key length (default: 64)

keys list

List API keys:

swiftclaw keys list <agent>

keys revoke

Revoke API key:

swiftclaw keys revoke <agent> [options]

Options:
  --key <key>              Key to revoke
  --name <name>            Key name to revoke

Config

config set

Set configuration value:

swiftclaw config set <key> <value> [options]

Options:
  --env <env>              Environment
  --agent <agent>          Agent name

config get

Get configuration value:

swiftclaw config get <key> [options]

Options:
  --env <env>              Environment
  --agent <agent>          Agent name

config list

List all configuration:

swiftclaw config list [options]

Options:
  --env <env>              Environment
  --agent <agent>          Agent name

Memory

memory search

Search agent memory:

swiftclaw memory search <agent> [options]

Options:
  --query <query>          Search query
  --limit <n>              Number of results

memory clear

Clear agent memory:

swiftclaw memory clear <agent> [options]

Options:
  --force, -f              Skip confirmation
  --older-than <duration>  Clear entries older than duration

Webhooks

webhooks create

Create webhook:

swiftclaw webhooks create <agent> [options]

Options:
  --url <url>              Webhook URL
  --events <events>        Comma-separated event types

webhooks list

List webhooks:

swiftclaw webhooks list <agent>

webhooks delete

Delete webhook:

swiftclaw webhooks delete <agent> <webhook-id>

Workspaces

workspaces create

Create workspace:

swiftclaw workspaces create <name>

workspaces list

List workspaces:

swiftclaw workspaces list

workspaces use

Switch workspace:

swiftclaw workspaces use <name>

Debug

debug

Enable debug mode:

swiftclaw debug <agent> [options]

Options:
  --enable                 Enable debug mode
  --disable                Disable debug mode

trace

View request traces:

swiftclaw trace <agent> [options]

Options:
  --id <trace-id>          Specific trace ID
  --latest                 Latest trace
  --timeline               Show timeline

Test

test

Run tests:

swiftclaw test <agent> [options]

Options:
  --env <env>              Environment
  --scenario <name>        Test scenario

Tab Completion: Enable tab completion with swiftclaw completion install

Next Steps

  • CLI Configuration
  • CLI Reference
  • Quick Start

How is this guide ?

Last updated on

CLI Reference

Complete reference for SwiftClaw CLI commands

CLI Configuration

Configuring the SwiftClaw CLI

On this page

CLI Commands
Global Options
Agents
create
list
status
delete
Deploy
deploy
rollback
Logs
logs
Metrics
metrics
Keys
keys create
keys list
keys revoke
Config
config set
config get
config list
Memory
memory search
memory clear
Webhooks
webhooks create
webhooks list
webhooks delete
Workspaces
workspaces create
workspaces list
workspaces use
Debug
debug
trace
Test
test
Next Steps