box
Run and describe Clanker Box agent sandboxes.
Clanker Box packages agent runtimes as HTTP services that can be deployed to Cloud Run or served locally. It supports an empty shell sandbox, native Clanker CLI runtime, Hermes, OpenClaw, Codex, and Claude Code adapters.
Usage
bash
clanker box [command]Commands
| Command | Description |
|---|---|
catalog | Print supported Clanker Box agents and Cloud Run regions as JSON |
manifest | Print a Cloud Run runtime manifest for a box |
install | Install one agent runtime or all supported runtimes |
serve | Serve a Clanker Box agent runtime over HTTP |
Catalog
bash
clanker box catalogThe catalog includes supported agents, default serve commands, required secrets, and available Cloud Run regions.
Current agent IDs include:
| Agent | Runtime | Notes |
|---|---|---|
empty | base-shell | Basic shell environment with terminal access |
clanker-cli | native-cli | Native Clanker CLI runtime for cloud operations and MCP workflows |
hermes | python-bridge | Hermes adapter; requires an OpenAI or Anthropic key |
openclaw | gateway-adapter | OpenClaw gateway adapter; requires OPENCLAW_GATEWAY_TOKEN |
codex | cli-adapter | Codex CLI adapter; requires CODEX_AUTH or OPENAI_API_KEY |
claude-code | cli-adapter | Claude Code adapter; requires an Anthropic key or Claude Code login |
Manifest
bash
clanker box manifest --agent clanker-cli --region us-central1 --project my-project
clanker box manifest --agent codex --image us-central1-docker.pkg.dev/my-project/agents/clankerbox:latest| Flag | Default | Description |
|---|---|---|
--name | clanker-box | Box display name |
--agent | clanker-cli | Agent to run: empty, hermes, openclaw, codex, claude-code, or clanker-cli |
--region | us-central1 | Cloud Run region |
--image | empty | Container image URI |
--project | empty | GCP project ID |
--service-account | empty | Runtime service account email |
--artifact-repo | empty | Artifact Registry repository |
--state-bucket | empty | Cloud Storage state bucket |
--control-plane-url | empty | Clanker Cloud control-plane URL |
--require-auth | true | Require X-API-Key or Bearer token for message endpoints |
--websocket-timeout-minutes | 60 | Cloud Run WebSocket request timeout target |
Install Runtime Adapters
bash
clanker box install codex
clanker box install claude-code
clanker box install allThe install command prints JSON with the result for each adapter. Runtime installs are on demand, so a basic empty or clanker-cli box can run without preinstalling every agent.
Serve
bash
PORT=8080 clanker box serve --agent clanker-cli
PORT=8080 clanker box serve --agent empty --name scratchserve reads runtime configuration from the environment and listens on :$PORT, defaulting to 8080.