Files
adolf/docs/install/clawdock.md
alvis bedb527145
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Vendor OpenClaw source as Adolf fork baseline
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11),
free to diverge. Tree copied sans upstream .git; upstream remote added for
future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19.
Preserves docs/ARCHITECTURE.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
2026-07-05 09:36:54 +00:00

4.8 KiB

summary, read_when, title
summary read_when title
ClawDock shell helpers for Docker-based OpenClaw installs
You run OpenClaw with Docker often and want shorter day-to-day commands
You want a helper layer for dashboard, logs, token setup, and pairing flows
ClawDock

ClawDock is a small shell-helper layer for Docker-based OpenClaw installs.

It gives you short commands like clawdock-start, clawdock-dashboard, and clawdock-fix-token instead of longer docker compose ... invocations.

If you have not set up Docker yet, start with Docker.

Install

mkdir -p ~/.clawdock && curl -sL https://raw.githubusercontent.com/openclaw/openclaw/main/scripts/clawdock/clawdock-helpers.sh -o ~/.clawdock/clawdock-helpers.sh
echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc

If you previously installed ClawDock from scripts/shell-helpers/clawdock-helpers.sh, reinstall from the current scripts/clawdock/clawdock-helpers.sh path; the old raw GitHub path was removed.

The helpers auto-detect your OpenClaw checkout on first use (checking common paths like ~/openclaw, ~/projects/openclaw) and cache the result in ~/.clawdock/config. Set CLAWDOCK_DIR yourself if your checkout lives elsewhere.

What you get

Basic operations

Command Description
clawdock-start Start the gateway
clawdock-stop Stop the gateway
clawdock-restart Restart the gateway
clawdock-status Check container status
clawdock-logs Follow gateway logs

Container access

Command Description
clawdock-shell Open a shell inside the gateway container
clawdock-cli <command> Run OpenClaw CLI commands in Docker
clawdock-exec <command> Execute an arbitrary command in the container

Web UI and pairing

Command Description
clawdock-dashboard Open the Control UI URL
clawdock-devices List pending device pairings
clawdock-approve <id> Approve a pairing request

Setup and maintenance

Command Description
clawdock-fix-token Write the gateway token into the container config
clawdock-update Pull, rebuild, and restart
clawdock-rebuild Rebuild the Docker image only
clawdock-clean Remove containers and volumes

Utilities

Command Description
clawdock-health Run a gateway health check
clawdock-token Print the gateway token
clawdock-cd Jump to the OpenClaw project directory
clawdock-config Open ~/.openclaw
clawdock-show-config Print config files with redacted values
clawdock-workspace Open the workspace directory
clawdock-help List all ClawDock commands

First-time flow

clawdock-start
clawdock-fix-token
clawdock-dashboard

If the browser says pairing is required:

clawdock-devices
clawdock-approve <request-id>

Config and secrets

ClawDock reads two separate .env files, matching the split described in Docker:

  • The project .env next to docker-compose.yml: Docker-specific values like image name, ports, and OPENCLAW_GATEWAY_TOKEN. clawdock-token reads the token from here.
  • ~/.openclaw/.env (mounted into the container): env-backed secrets OpenClaw itself manages, alongside openclaw.json and agents/<agentId>/agent/auth-profiles.json.

clawdock-fix-token copies the token from the project .env into the container's gateway.remote.token and gateway.auth.token config values and restarts the gateway.

Use clawdock-show-config to inspect openclaw.json and both .env files quickly; it redacts .env values in its printed output.

Canonical Docker install for OpenClaw. Docker-managed VM runtime for hardened isolation. Updating the OpenClaw package and managed services.