Documentation
CLI Reference

CLI Reference

ClawMachine is a single binary. clawmachine without a subcommand runs serve.

Command Summary 

clawmachine serve
clawmachine install
clawmachine upgrade
clawmachine uninstall
clawmachine doctor
clawmachine status
clawmachine backup
clawmachine restore
clawmachine completion [bash|zsh|fish|powershell]
clawmachine version
clawmachine version --all

Global Flags

FlagDefaultDescription
--contextcurrent kube contextKubernetes context to use
--devfalseEnable dev mode for serve
--webfalseAlias-style flag for web mode

serve 

clawmachine
clawmachine serve
clawmachine serve --dev

Environment variables:

VariableDefaultDescription
PORT8080Listen port
LOG_LEVELinfodebug, info, warn, error

install 

clawmachine install
clawmachine install --namespace claw-machine --external-secrets --cilium
clawmachine install --context my-cluster --name clawmachine --yes
FlagDefaultDescription
--namespaceclaw-machineTarget namespace
--nameclawmachineHelm release name
--external-secretsfalseInstall External Secrets Operator
--ciliumfalseInstall Cilium CNI
--interactivetrueRun interactive installer
--yes, -yfalseSkip confirmation prompts

upgrade 

clawmachine upgrade
clawmachine upgrade --namespace claw-machine --name clawmachine --yes
FlagDefaultDescription
--namespaceclaw-machineTarget namespace
--nameclawmachineHelm release name
--yes, -yfalseSkip confirmation prompt

uninstall 

clawmachine uninstall
clawmachine uninstall --namespace claw-machine --yes

doctor 

clawmachine doctor

status 

clawmachine status

backup and restore 

clawmachine backup --bucket my-backups
clawmachine restore --bucket my-backups

See full flags with:

clawmachine backup --help
clawmachine restore --help

completion 

clawmachine completion zsh
clawmachine completion bash

version 

clawmachine version
clawmachine version --all

clawmachine version prints the CLI version.

clawmachine version --all also prints:

  • Canonical bot image refs (repo:tag) from embedded bot charts
  • SHA256 checksums for vendored embedded charts (External Secrets, Cilium, Connect)

Example:

clawmachine v0.1.0

bot images (canonical repo:tag):
  - openclaw: ghcr.io/zackerydev/openclaw:0.1.0
  - picoclaw: ghcr.io/zackerydev/picoclaw:0.1.0
  - ironclaw: ghcr.io/zackerydev/ironclaw:0.1.0
  - busybox: ghcr.io/zackerydev/theclawmachine-toolbox:0.1.0

vendored charts (sha256):
  - [email protected]: sha256:<digest>
  - [email protected]: sha256:<digest>
  - [email protected]: sha256:<digest>

HTTP API Endpoints (Serve Mode)

Core

MethodPath
GET/health
GET/static/*

Pages

MethodPath
GET/
GET/bots/new
POST/bots/new/infra
POST/bots/new/config
GET/bots/{name}/page
GET/settings
GET/settings/providers
GET/secrets
GET/secrets/new (redirects to /secrets)

Bot Operations

MethodPath
GET/bots
POST/bots
GET/bots/{name}
PUT/bots/{name}
DELETE/bots/{name}
GET/bots/{name}/logs
POST/bots/{name}/cli
POST/bots/{name}/restart
PUT/bots/{name}/config
GET/bots/{name}/network
GET/bots/{name}/backup
POST/bots/{name}/backup

Settings and Secrets

MethodPath
GET/settings/status
POST/settings/provider
DELETE/settings/provider
POST/settings/connect/install
DELETE/settings/connect
GET/secrets/available
GET/secrets/status
POST/secrets
DELETE/secrets/{name}

API Helpers

MethodPath
GET/api/botenv
GET/api/models
GET/api/onboarding/profile
POST/api/onboarding/preview

HTMX requests are supported for page partials (HX-Request: true).

Network SecurityAdvanced Setup