mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 06:20:43 +00:00
9671a91590
docs/install/clawdock.md: renamed '## Related pages' to '## Related' for consistency with sibling install docs and converted the 3-bullet list into a CardGroup linking docker, docker-vm-runtime, and updating. docs/install/nix.md: replaced 2 typography characters with ASCII equivalents and converted the 3-bullet Related list into a CardGroup, adding an Updating card so readers wiring nix-openclaw next to a managed install see the upgrade path. docs/concepts/features.md: converted the 2-bullet Related list into a CardGroup, adding cross-links to channels and plugins so the page now points readers at both deeper concepts (experimental features, agent runtime) and direct surfaces (channels, plugins). docs/tools/pdf.md: replaced 2 typography characters with ASCII equivalents.
113 lines
4.3 KiB
Markdown
113 lines
4.3 KiB
Markdown
---
|
|
summary: "ClawDock shell helpers for Docker-based OpenClaw installs"
|
|
read_when:
|
|
- 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
|
|
title: "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/docker).
|
|
|
|
## Install
|
|
|
|
Use the canonical helper path:
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
clawdock-start
|
|
clawdock-fix-token
|
|
clawdock-dashboard
|
|
```
|
|
|
|
If the browser says pairing is required:
|
|
|
|
```bash
|
|
clawdock-devices
|
|
clawdock-approve <request-id>
|
|
```
|
|
|
|
## Config and secrets
|
|
|
|
ClawDock works with the same Docker config split described in [Docker](/install/docker):
|
|
|
|
- `<project>/.env` for Docker-specific values like image name, ports, and the gateway token
|
|
- `~/.openclaw/.env` for env-backed provider keys and bot tokens
|
|
- `~/.openclaw/agents/<agentId>/agent/auth-profiles.json` for stored provider OAuth/API-key auth
|
|
- `~/.openclaw/openclaw.json` for behavior config
|
|
|
|
Use `clawdock-show-config` when you want to inspect the `.env` files and `openclaw.json` quickly. It redacts `.env` values in its printed output.
|
|
|
|
## Related
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Docker" href="/install/docker" icon="docker">
|
|
Canonical Docker install for OpenClaw.
|
|
</Card>
|
|
<Card title="Docker VM runtime" href="/install/docker-vm-runtime" icon="cube">
|
|
Docker-managed VM runtime for hardened isolation.
|
|
</Card>
|
|
<Card title="Updating" href="/install/updating" icon="arrow-up-right-from-square">
|
|
Updating the OpenClaw package and managed services.
|
|
</Card>
|
|
</CardGroup>
|