openclaw/docs/install/clawdock.md at 567ca3a56fdb3c0cf5fa191bb467ea4468bfe9bc

mirror of https://github.com/openclaw/openclaw.git synced 2026-04-01 15:07:13 +02:00

Files

Daniel Olshansky 6e1f00dc86 [ClawDock] Iteration on the first submission; bug fixes, UX improvements, etc (#23912 )

Merged via squash.

Prepared head SHA: 30c5ef37a4
Co-authored-by: Olshansk <1892194+Olshansk@users.noreply.github.com>
Co-authored-by: gumadeiras <5599352+gumadeiras@users.noreply.github.com>
Reviewed-by: @gumadeiras

2026-03-29 20:05:41 -04:00

3.9 KiB

Raw Blame History

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

Use the canonical helper path:

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 new scripts/clawdock/clawdock-helpers.sh path. The old raw GitHub path was removed.

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`	Configure the gateway token inside the container
`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

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 works with the same Docker config split described in Docker:

<project>/.env for Docker-specific values like image name, ports, and the gateway token
~/.openclaw/.env for provider keys and bot tokens
~/.openclaw/openclaw.json for behavior config

Use clawdock-show-config when you want to inspect those files quickly. It redacts .env values in its printed output.

3.9 KiB Raw Blame History