mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-12 07:20:45 +00:00
feat: ClawDock - shell docker helpers for OpenClaw development (#12817)
Discussion: https://github.com/openclaw/openclaw/discussions/13528 ## Checklist - [x] **Mark as AI-assisted in the PR title or description** - Implemented by 🤖, reviewed by 👨💻 - [x] **Note the degree of testing** - fully tested and I use it myself - [x] **Include prompts or session logs if possible (super helpful!)** - I can try doing a "resume" on a few sessions, but don't think it'll provide value. Lmk if this is a blocker. - [x] **Confirm you understand what the code does** - It's simple :) ## Summary of changes - **ClawDock** - Shell helpers replace verbose `docker-compose` commands with simple `clawdock-*` shortcuts - **Zero-config setup** - First run auto-detects the OpenClaw project directory from common paths and saves the config for future use - **No extra dependencies** - Just bash - **Built-in auth & device pairing helpers** - `clawdock-fix-token`, `clawdock-dashboard`, etc to handle gateay setup, streamline web UI, etc... - **Updated Docker docs** - Installation docs now include the optional ClawDock helper setup for users who want simplified container management ## Example Usage ```bash $ clawdock-help 🦞 ClawDock - Docker Helpers for OpenClaw ⚡ Basic Operations clawdock-start Start the gateway clawdock-stop Stop the gateway clawdock-restart Restart the gateway clawdock-status Check container status clawdock-logs View live logs (follows) 🐚 Container Access clawdock-shell Shell into container (openclaw alias ready) clawdock-cli Run CLI commands (e.g., clawdock-cli status) clawdock-exec <cmd> Execute command in gateway container 🌐 Web UI & Devices clawdock-dashboard Open web UI in browser (auto-guides you) clawdock-devices List device pairings (auto-guides you) clawdock-approve <id> Approve device pairing (with examples) ⚙️ Setup & Configuration clawdock-fix-token Configure gateway token (run once) 🔧 Maintenance clawdock-rebuild Rebuild Docker image clawdock-clean ⚠️ Remove containers & volumes (nuclear) 🛠️ Utilities clawdock-health Run health check clawdock-token Show gateway auth token clawdock-cd Jump to openclaw project directory clawdock-config Open config directory (~/.openclaw) clawdock-workspace Open workspace directory ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 🚀 First Time Setup 1. clawdock-start # Start the gateway 2. clawdock-fix-token # Configure token 3. clawdock-dashboard # Open web UI 4. clawdock-devices # If pairing needed 5. clawdock-approve <id> # Approve pairing 💬 WhatsApp Setup clawdock-shell > openclaw channels login --channel whatsapp > openclaw status ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 💡 All commands guide you through next steps! 📚 Docs: https://docs.openclaw.ai ```\n\nCo-authored-by: Gustavo Madeira Santana <gumadeiras@gmail.com>
This commit is contained in:
@@ -7,6 +7,7 @@ Docs: https://docs.openclaw.ai
|
||||
### Added
|
||||
|
||||
- Commands: add `commands.allowFrom` config for separate command authorization, allowing operators to restrict slash commands to specific users while keeping chat open to others. (#12430) Thanks @thewilloftheshadow.
|
||||
- Docker: add ClawDock shell helpers for Docker workflows. (#12817) Thanks @Olshansk.
|
||||
- iOS: alpha node app + setup-code onboarding. (#11756) Thanks @mbelinky.
|
||||
- Channels: comprehensive BlueBubbles and channel cleanup. (#11093) Thanks @tyler6204.
|
||||
- Plugins: device pairing + phone control plugins (Telegram `/pair`, iOS/Android node controls). (#11755) Thanks @mbelinky.
|
||||
|
||||
@@ -65,6 +65,24 @@ It writes config/workspace on the host:
|
||||
|
||||
Running on a VPS? See [Hetzner (Docker VPS)](/install/hetzner).
|
||||
|
||||
### Shell Helpers (optional)
|
||||
|
||||
For easier day-to-day Docker management, install `ClawDock`:
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.clawdock && curl -sL https://raw.githubusercontent.com/openclaw/openclaw/main/scripts/shell-helpers/clawdock-helpers.sh -o ~/.clawdock/clawdock-helpers.sh
|
||||
```
|
||||
|
||||
**Add to your shell config (zsh):**
|
||||
|
||||
```bash
|
||||
echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc
|
||||
```
|
||||
|
||||
Then use `clawdock-start`, `clawdock-stop`, `clawdock-dashboard`, etc. Run `clawdock-help` for all commands.
|
||||
|
||||
See [`ClawDock` Helper README](https://github.com/openclaw/openclaw/blob/main/scripts/shell-helpers/README.md) for details.
|
||||
|
||||
### Manual flow (compose)
|
||||
|
||||
```bash
|
||||
|
||||
226
scripts/shell-helpers/README.md
Normal file
226
scripts/shell-helpers/README.md
Normal file
@@ -0,0 +1,226 @@
|
||||
# ClawDock <!-- omit in toc -->
|
||||
|
||||
Stop typing `docker-compose` commands. Just type `clawdock-start`.
|
||||
|
||||
Inspired by Simon Willison's [Running OpenClaw in Docker](https://til.simonwillison.net/llms/openclaw-docker).
|
||||
|
||||
- [Quickstart](#quickstart)
|
||||
- [Available Commands](#available-commands)
|
||||
- [Basic Operations](#basic-operations)
|
||||
- [Container Access](#container-access)
|
||||
- [Web UI \& Devices](#web-ui--devices)
|
||||
- [Setup \& Configuration](#setup--configuration)
|
||||
- [Maintenance](#maintenance)
|
||||
- [Utilities](#utilities)
|
||||
- [Common Workflows](#common-workflows)
|
||||
- [Check Status and Logs](#check-status-and-logs)
|
||||
- [Set Up WhatsApp Bot](#set-up-whatsapp-bot)
|
||||
- [Troubleshooting Device Pairing](#troubleshooting-device-pairing)
|
||||
- [Fix Token Mismatch Issues](#fix-token-mismatch-issues)
|
||||
- [Permission Denied](#permission-denied)
|
||||
- [Requirements](#requirements)
|
||||
|
||||
## Quickstart
|
||||
|
||||
**Install:**
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.clawdock && curl -sL https://raw.githubusercontent.com/openclaw/openclaw/main/scripts/shell-helpers/clawdock-helpers.sh -o ~/.clawdock/clawdock-helpers.sh
|
||||
```
|
||||
|
||||
```bash
|
||||
echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc && source ~/.zshrc
|
||||
```
|
||||
|
||||
**See what you get:**
|
||||
|
||||
```bash
|
||||
clawdock-help
|
||||
```
|
||||
|
||||
On first command, ClawDock auto-detects your OpenClaw directory:
|
||||
|
||||
- Checks common paths (`~/openclaw`, `~/workspace/openclaw`, etc.)
|
||||
- If found, asks you to confirm
|
||||
- Saves to `~/.clawdock/config`
|
||||
|
||||
**First time setup:**
|
||||
|
||||
```bash
|
||||
clawdock-start
|
||||
```
|
||||
|
||||
```bash
|
||||
clawdock-fix-token
|
||||
```
|
||||
|
||||
```bash
|
||||
clawdock-dashboard
|
||||
```
|
||||
|
||||
If you see "pairing required":
|
||||
|
||||
```bash
|
||||
clawdock-devices
|
||||
```
|
||||
|
||||
And approve the request for the specific device:
|
||||
|
||||
```bash
|
||||
clawdock-approve <request-id>
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
### 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` | View live logs (follows output) |
|
||||
|
||||
### Container Access
|
||||
|
||||
| Command | Description |
|
||||
| ------------------------- | ---------------------------------------------- |
|
||||
| `clawdock-shell` | Interactive shell inside the gateway container |
|
||||
| `clawdock-cli <command>` | Run OpenClaw CLI commands |
|
||||
| `clawdock-exec <command>` | Execute arbitrary commands in the container |
|
||||
|
||||
### Web UI & Devices
|
||||
|
||||
| Command | Description |
|
||||
| ----------------------- | ------------------------------------------ |
|
||||
| `clawdock-dashboard` | Open web UI in browser with authentication |
|
||||
| `clawdock-devices` | List device pairing requests |
|
||||
| `clawdock-approve <id>` | Approve a device pairing request |
|
||||
|
||||
### Setup & Configuration
|
||||
|
||||
| Command | Description |
|
||||
| -------------------- | ------------------------------------------------- |
|
||||
| `clawdock-fix-token` | Configure gateway authentication token (run once) |
|
||||
|
||||
### Maintenance
|
||||
|
||||
| Command | Description |
|
||||
| ------------------ | ------------------------------------------------ |
|
||||
| `clawdock-rebuild` | Rebuild the Docker image |
|
||||
| `clawdock-clean` | Remove all containers and volumes (destructive!) |
|
||||
|
||||
### Utilities
|
||||
|
||||
| Command | Description |
|
||||
| -------------------- | ----------------------------------------- |
|
||||
| `clawdock-health` | Run gateway health check |
|
||||
| `clawdock-token` | Display the gateway authentication token |
|
||||
| `clawdock-cd` | Jump to the OpenClaw project directory |
|
||||
| `clawdock-config` | Open the OpenClaw config directory |
|
||||
| `clawdock-workspace` | Open the workspace directory |
|
||||
| `clawdock-help` | Show all available commands with examples |
|
||||
|
||||
## Common Workflows
|
||||
|
||||
### Check Status and Logs
|
||||
|
||||
**Restart the gateway:**
|
||||
|
||||
```bash
|
||||
clawdock-restart
|
||||
```
|
||||
|
||||
**Check container status:**
|
||||
|
||||
```bash
|
||||
clawdock-status
|
||||
```
|
||||
|
||||
**View live logs:**
|
||||
|
||||
```bash
|
||||
clawdock-logs
|
||||
```
|
||||
|
||||
### Set Up WhatsApp Bot
|
||||
|
||||
**Shell into the container:**
|
||||
|
||||
```bash
|
||||
clawdock-shell
|
||||
```
|
||||
|
||||
**Inside the container, login to WhatsApp:**
|
||||
|
||||
```bash
|
||||
openclaw channels login --channel whatsapp --verbose
|
||||
```
|
||||
|
||||
Scan the QR code with WhatsApp on your phone.
|
||||
|
||||
**Verify connection:**
|
||||
|
||||
```bash
|
||||
openclaw status
|
||||
```
|
||||
|
||||
### Troubleshooting Device Pairing
|
||||
|
||||
**Check for pending pairing requests:**
|
||||
|
||||
```bash
|
||||
clawdock-devices
|
||||
```
|
||||
|
||||
**Copy the Request ID from the "Pending" table, then approve:**
|
||||
|
||||
```bash
|
||||
clawdock-approve <request-id>
|
||||
```
|
||||
|
||||
Then refresh your browser.
|
||||
|
||||
### Fix Token Mismatch Issues
|
||||
|
||||
If you see "gateway token mismatch" errors:
|
||||
|
||||
```bash
|
||||
clawdock-fix-token
|
||||
```
|
||||
|
||||
This will:
|
||||
|
||||
1. Read the token from your `.env` file
|
||||
2. Configure it in the OpenClaw config
|
||||
3. Restart the gateway
|
||||
4. Verify the configuration
|
||||
|
||||
### Permission Denied
|
||||
|
||||
**Ensure Docker is running and you have permission:**
|
||||
|
||||
```bash
|
||||
docker ps
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
- Docker and Docker Compose installed
|
||||
- Bash or Zsh shell
|
||||
- OpenClaw project (from `docker-setup.sh`)
|
||||
|
||||
## Development
|
||||
|
||||
**Test with fresh config (mimics first-time install):**
|
||||
|
||||
```bash
|
||||
unset CLAWDOCK_DIR && rm -f ~/.clawdock/config && source scripts/shell-helpers/clawdock-helpers.sh
|
||||
```
|
||||
|
||||
Then run any command to trigger auto-detect:
|
||||
|
||||
```bash
|
||||
clawdock-start
|
||||
```
|
||||
413
scripts/shell-helpers/clawdock-helpers.sh
Executable file
413
scripts/shell-helpers/clawdock-helpers.sh
Executable file
@@ -0,0 +1,413 @@
|
||||
#!/usr/bin/env bash
|
||||
# ClawDock - Docker helpers for OpenClaw
|
||||
# Inspired by Simon Willison's "Running OpenClaw in Docker"
|
||||
# https://til.simonwillison.net/llms/openclaw-docker
|
||||
#
|
||||
# Installation:
|
||||
# mkdir -p ~/.clawdock && curl -sL https://raw.githubusercontent.com/openclaw/openclaw/main/scripts/shell-helpers/clawdock-helpers.sh -o ~/.clawdock/clawdock-helpers.sh
|
||||
# echo 'source ~/.clawdock/clawdock-helpers.sh' >> ~/.zshrc
|
||||
#
|
||||
# Usage:
|
||||
# clawdock-help # Show all available commands
|
||||
|
||||
# =============================================================================
|
||||
# Colors
|
||||
# =============================================================================
|
||||
_CLR_RESET='\033[0m'
|
||||
_CLR_BOLD='\033[1m'
|
||||
_CLR_DIM='\033[2m'
|
||||
_CLR_GREEN='\033[0;32m'
|
||||
_CLR_YELLOW='\033[1;33m'
|
||||
_CLR_BLUE='\033[0;34m'
|
||||
_CLR_MAGENTA='\033[0;35m'
|
||||
_CLR_CYAN='\033[0;36m'
|
||||
_CLR_RED='\033[0;31m'
|
||||
|
||||
# Styled command output (green + bold)
|
||||
_clr_cmd() {
|
||||
echo -e "${_CLR_GREEN}${_CLR_BOLD}$1${_CLR_RESET}"
|
||||
}
|
||||
|
||||
# Inline command for use in sentences
|
||||
_cmd() {
|
||||
echo "${_CLR_GREEN}${_CLR_BOLD}$1${_CLR_RESET}"
|
||||
}
|
||||
|
||||
# =============================================================================
|
||||
# Config
|
||||
# =============================================================================
|
||||
CLAWDOCK_CONFIG="${HOME}/.clawdock/config"
|
||||
|
||||
# Common paths to check for OpenClaw
|
||||
CLAWDOCK_COMMON_PATHS=(
|
||||
"${HOME}/openclaw"
|
||||
"${HOME}/workspace/openclaw"
|
||||
"${HOME}/projects/openclaw"
|
||||
"${HOME}/dev/openclaw"
|
||||
"${HOME}/code/openclaw"
|
||||
"${HOME}/src/openclaw"
|
||||
)
|
||||
|
||||
_clawdock_filter_warnings() {
|
||||
grep -v "^WARN\|^time="
|
||||
}
|
||||
|
||||
_clawdock_trim_quotes() {
|
||||
local value="$1"
|
||||
value="${value#\"}"
|
||||
value="${value%\"}"
|
||||
printf "%s" "$value"
|
||||
}
|
||||
|
||||
_clawdock_read_config_dir() {
|
||||
if [[ ! -f "$CLAWDOCK_CONFIG" ]]; then
|
||||
return 1
|
||||
fi
|
||||
local raw
|
||||
raw=$(sed -n 's/^CLAWDOCK_DIR=//p' "$CLAWDOCK_CONFIG" | head -n 1)
|
||||
if [[ -z "$raw" ]]; then
|
||||
return 1
|
||||
fi
|
||||
_clawdock_trim_quotes "$raw"
|
||||
}
|
||||
|
||||
# Ensure CLAWDOCK_DIR is set and valid
|
||||
_clawdock_ensure_dir() {
|
||||
# Already set and valid?
|
||||
if [[ -n "$CLAWDOCK_DIR" && -f "${CLAWDOCK_DIR}/docker-compose.yml" ]]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Try loading from config
|
||||
local config_dir
|
||||
config_dir=$(_clawdock_read_config_dir)
|
||||
if [[ -n "$config_dir" && -f "${config_dir}/docker-compose.yml" ]]; then
|
||||
CLAWDOCK_DIR="$config_dir"
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Auto-detect from common paths
|
||||
local found_path=""
|
||||
for path in "${CLAWDOCK_COMMON_PATHS[@]}"; do
|
||||
if [[ -f "${path}/docker-compose.yml" ]]; then
|
||||
found_path="$path"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
if [[ -n "$found_path" ]]; then
|
||||
echo ""
|
||||
echo "🦞 Found OpenClaw at: $found_path"
|
||||
echo -n " Use this location? [Y/n] "
|
||||
read -r response
|
||||
if [[ "$response" =~ ^[Nn] ]]; then
|
||||
echo ""
|
||||
echo "Set CLAWDOCK_DIR manually:"
|
||||
echo " export CLAWDOCK_DIR=/path/to/openclaw"
|
||||
return 1
|
||||
fi
|
||||
CLAWDOCK_DIR="$found_path"
|
||||
else
|
||||
echo ""
|
||||
echo "❌ OpenClaw not found in common locations."
|
||||
echo ""
|
||||
echo "Clone it first:"
|
||||
echo ""
|
||||
echo " git clone https://github.com/openclaw/openclaw.git ~/openclaw"
|
||||
echo " cd ~/openclaw && ./docker-setup.sh"
|
||||
echo ""
|
||||
echo "Or set CLAWDOCK_DIR if it's elsewhere:"
|
||||
echo ""
|
||||
echo " export CLAWDOCK_DIR=/path/to/openclaw"
|
||||
echo ""
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Save to config
|
||||
if [[ ! -d "${HOME}/.clawdock" ]]; then
|
||||
/bin/mkdir -p "${HOME}/.clawdock"
|
||||
fi
|
||||
echo "CLAWDOCK_DIR=\"$CLAWDOCK_DIR\"" > "$CLAWDOCK_CONFIG"
|
||||
echo "✅ Saved to $CLAWDOCK_CONFIG"
|
||||
echo ""
|
||||
return 0
|
||||
}
|
||||
|
||||
# Wrapper to run docker compose commands
|
||||
_clawdock_compose() {
|
||||
_clawdock_ensure_dir || return 1
|
||||
command docker compose -f "${CLAWDOCK_DIR}/docker-compose.yml" "$@"
|
||||
}
|
||||
|
||||
_clawdock_read_env_token() {
|
||||
_clawdock_ensure_dir || return 1
|
||||
if [[ ! -f "${CLAWDOCK_DIR}/.env" ]]; then
|
||||
return 1
|
||||
fi
|
||||
local raw
|
||||
raw=$(sed -n 's/^OPENCLAW_GATEWAY_TOKEN=//p' "${CLAWDOCK_DIR}/.env" | head -n 1)
|
||||
if [[ -z "$raw" ]]; then
|
||||
return 1
|
||||
fi
|
||||
_clawdock_trim_quotes "$raw"
|
||||
}
|
||||
|
||||
# Basic Operations
|
||||
clawdock-start() {
|
||||
_clawdock_compose up -d openclaw-gateway
|
||||
}
|
||||
|
||||
clawdock-stop() {
|
||||
_clawdock_compose down
|
||||
}
|
||||
|
||||
clawdock-restart() {
|
||||
_clawdock_compose restart openclaw-gateway
|
||||
}
|
||||
|
||||
clawdock-logs() {
|
||||
_clawdock_compose logs -f openclaw-gateway
|
||||
}
|
||||
|
||||
clawdock-status() {
|
||||
_clawdock_compose ps
|
||||
}
|
||||
|
||||
# Navigation
|
||||
clawdock-cd() {
|
||||
_clawdock_ensure_dir || return 1
|
||||
cd "${CLAWDOCK_DIR}"
|
||||
}
|
||||
|
||||
clawdock-config() {
|
||||
cd ~/.openclaw
|
||||
}
|
||||
|
||||
clawdock-workspace() {
|
||||
cd ~/.openclaw/workspace
|
||||
}
|
||||
|
||||
# Container Access
|
||||
clawdock-shell() {
|
||||
_clawdock_compose exec openclaw-gateway \
|
||||
bash -c 'echo "alias openclaw=\"./openclaw.mjs\"" > /tmp/.bashrc_openclaw && bash --rcfile /tmp/.bashrc_openclaw'
|
||||
}
|
||||
|
||||
clawdock-exec() {
|
||||
_clawdock_compose exec openclaw-gateway "$@"
|
||||
}
|
||||
|
||||
clawdock-cli() {
|
||||
_clawdock_compose run --rm openclaw-cli "$@"
|
||||
}
|
||||
|
||||
# Maintenance
|
||||
clawdock-rebuild() {
|
||||
_clawdock_compose build openclaw-gateway
|
||||
}
|
||||
|
||||
clawdock-clean() {
|
||||
_clawdock_compose down -v --remove-orphans
|
||||
}
|
||||
|
||||
# Health check
|
||||
clawdock-health() {
|
||||
_clawdock_ensure_dir || return 1
|
||||
local token
|
||||
token=$(_clawdock_read_env_token)
|
||||
if [[ -z "$token" ]]; then
|
||||
echo "❌ Error: Could not find gateway token"
|
||||
echo " Check: ${CLAWDOCK_DIR}/.env"
|
||||
return 1
|
||||
fi
|
||||
_clawdock_compose exec -e "OPENCLAW_GATEWAY_TOKEN=$token" openclaw-gateway \
|
||||
node dist/index.js health
|
||||
}
|
||||
|
||||
# Show gateway token
|
||||
clawdock-token() {
|
||||
_clawdock_read_env_token
|
||||
}
|
||||
|
||||
# Fix token configuration (run this once after setup)
|
||||
clawdock-fix-token() {
|
||||
_clawdock_ensure_dir || return 1
|
||||
|
||||
echo "🔧 Configuring gateway token..."
|
||||
local token
|
||||
token=$(clawdock-token)
|
||||
if [[ -z "$token" ]]; then
|
||||
echo "❌ Error: Could not find gateway token"
|
||||
echo " Check: ${CLAWDOCK_DIR}/.env"
|
||||
return 1
|
||||
fi
|
||||
|
||||
echo "📝 Setting token: ${token:0:20}..."
|
||||
|
||||
_clawdock_compose exec -e "TOKEN=$token" openclaw-gateway \
|
||||
bash -c './openclaw.mjs config set gateway.remote.token "$TOKEN" && ./openclaw.mjs config set gateway.auth.token "$TOKEN"' 2>&1 | _clawdock_filter_warnings
|
||||
|
||||
echo "🔍 Verifying token was saved..."
|
||||
local saved_token
|
||||
saved_token=$(_clawdock_compose exec openclaw-gateway \
|
||||
bash -c "./openclaw.mjs config get gateway.remote.token 2>/dev/null" 2>&1 | _clawdock_filter_warnings | tr -d '\r\n' | head -c 64)
|
||||
|
||||
if [[ "$saved_token" == "$token" ]]; then
|
||||
echo "✅ Token saved correctly!"
|
||||
else
|
||||
echo "⚠️ Token mismatch detected"
|
||||
echo " Expected: ${token:0:20}..."
|
||||
echo " Got: ${saved_token:0:20}..."
|
||||
fi
|
||||
|
||||
echo "🔄 Restarting gateway..."
|
||||
_clawdock_compose restart openclaw-gateway 2>&1 | _clawdock_filter_warnings
|
||||
|
||||
echo "⏳ Waiting for gateway to start..."
|
||||
sleep 5
|
||||
|
||||
echo "✅ Configuration complete!"
|
||||
echo -e " Try: $(_cmd clawdock-devices)"
|
||||
}
|
||||
|
||||
# Open dashboard in browser
|
||||
clawdock-dashboard() {
|
||||
_clawdock_ensure_dir || return 1
|
||||
|
||||
echo "🦞 Getting dashboard URL..."
|
||||
local output status url
|
||||
output=$(_clawdock_compose run --rm openclaw-cli dashboard --no-open 2>&1)
|
||||
status=$?
|
||||
url=$(printf "%s\n" "$output" | _clawdock_filter_warnings | grep -o 'http[s]\?://[^[:space:]]*' | head -n 1)
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "❌ Failed to get dashboard URL"
|
||||
echo -e " Try restarting: $(_cmd clawdock-restart)"
|
||||
return 1
|
||||
fi
|
||||
|
||||
if [[ -n "$url" ]]; then
|
||||
echo "✅ Opening: $url"
|
||||
open "$url" 2>/dev/null || xdg-open "$url" 2>/dev/null || echo " Please open manually: $url"
|
||||
echo ""
|
||||
echo -e "${_CLR_CYAN}💡 If you see 'pairing required' error:${_CLR_RESET}"
|
||||
echo -e " 1. Run: $(_cmd clawdock-devices)"
|
||||
echo " 2. Copy the Request ID from the Pending table"
|
||||
echo -e " 3. Run: $(_cmd 'clawdock-approve <request-id>')"
|
||||
else
|
||||
echo "❌ Failed to get dashboard URL"
|
||||
echo -e " Try restarting: $(_cmd clawdock-restart)"
|
||||
fi
|
||||
}
|
||||
|
||||
# List device pairings
|
||||
clawdock-devices() {
|
||||
_clawdock_ensure_dir || return 1
|
||||
|
||||
echo "🔍 Checking device pairings..."
|
||||
local output status
|
||||
output=$(_clawdock_compose exec openclaw-gateway node dist/index.js devices list 2>&1)
|
||||
status=$?
|
||||
printf "%s\n" "$output" | _clawdock_filter_warnings
|
||||
if [ $status -ne 0 ]; then
|
||||
echo ""
|
||||
echo -e "${_CLR_CYAN}💡 If you see token errors above:${_CLR_RESET}"
|
||||
echo -e " 1. Verify token is set: $(_cmd clawdock-token)"
|
||||
echo " 2. Try manual config inside container:"
|
||||
echo -e " $(_cmd clawdock-shell)"
|
||||
echo -e " $(_cmd 'openclaw config get gateway.remote.token')"
|
||||
return 1
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${_CLR_CYAN}💡 To approve a pairing request:${_CLR_RESET}"
|
||||
echo -e " $(_cmd 'clawdock-approve <request-id>')"
|
||||
}
|
||||
|
||||
# Approve device pairing request
|
||||
clawdock-approve() {
|
||||
_clawdock_ensure_dir || return 1
|
||||
|
||||
if [[ -z "$1" ]]; then
|
||||
echo -e "❌ Usage: $(_cmd 'clawdock-approve <request-id>')"
|
||||
echo ""
|
||||
echo -e "${_CLR_CYAN}💡 How to approve a device:${_CLR_RESET}"
|
||||
echo -e " 1. Run: $(_cmd clawdock-devices)"
|
||||
echo " 2. Find the Request ID in the Pending table (long UUID)"
|
||||
echo -e " 3. Run: $(_cmd 'clawdock-approve <that-request-id>')"
|
||||
echo ""
|
||||
echo "Example:"
|
||||
echo -e " $(_cmd 'clawdock-approve 6f9db1bd-a1cc-4d3f-b643-2c195262464e')"
|
||||
return 1
|
||||
fi
|
||||
|
||||
echo "✅ Approving device: $1"
|
||||
_clawdock_compose exec openclaw-gateway \
|
||||
node dist/index.js devices approve "$1" 2>&1 | _clawdock_filter_warnings
|
||||
|
||||
echo ""
|
||||
echo "✅ Device approved! Refresh your browser."
|
||||
}
|
||||
|
||||
# Show all available clawdock helper commands
|
||||
clawdock-help() {
|
||||
echo -e "\n${_CLR_BOLD}${_CLR_CYAN}🦞 ClawDock - Docker Helpers for OpenClaw${_CLR_RESET}\n"
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_MAGENTA}⚡ Basic Operations${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-start) ${_CLR_DIM}Start the gateway${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-stop) ${_CLR_DIM}Stop the gateway${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-restart) ${_CLR_DIM}Restart the gateway${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-status) ${_CLR_DIM}Check container status${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-logs) ${_CLR_DIM}View live logs (follows)${_CLR_RESET}"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_MAGENTA}🐚 Container Access${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-shell) ${_CLR_DIM}Shell into container (openclaw alias ready)${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-cli) ${_CLR_DIM}Run CLI commands (e.g., clawdock-cli status)${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-exec) ${_CLR_CYAN}<cmd>${_CLR_RESET} ${_CLR_DIM}Execute command in gateway container${_CLR_RESET}"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_MAGENTA}🌐 Web UI & Devices${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-dashboard) ${_CLR_DIM}Open web UI in browser ${_CLR_CYAN}(auto-guides you)${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-devices) ${_CLR_DIM}List device pairings ${_CLR_CYAN}(auto-guides you)${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-approve) ${_CLR_CYAN}<id>${_CLR_RESET} ${_CLR_DIM}Approve device pairing ${_CLR_CYAN}(with examples)${_CLR_RESET}"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_MAGENTA}⚙️ Setup & Configuration${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-fix-token) ${_CLR_DIM}Configure gateway token ${_CLR_CYAN}(run once)${_CLR_RESET}"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_MAGENTA}🔧 Maintenance${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-rebuild) ${_CLR_DIM}Rebuild Docker image${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-clean) ${_CLR_RED}⚠️ Remove containers & volumes (nuclear)${_CLR_RESET}"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_MAGENTA}🛠️ Utilities${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-health) ${_CLR_DIM}Run health check${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-token) ${_CLR_DIM}Show gateway auth token${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-cd) ${_CLR_DIM}Jump to openclaw project directory${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-config) ${_CLR_DIM}Open config directory (~/.openclaw)${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-workspace) ${_CLR_DIM}Open workspace directory${_CLR_RESET}"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_CYAN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${_CLR_RESET}"
|
||||
echo -e "${_CLR_BOLD}${_CLR_GREEN}🚀 First Time Setup${_CLR_RESET}"
|
||||
echo -e "${_CLR_CYAN} 1.${_CLR_RESET} $(_cmd clawdock-start) ${_CLR_DIM}# Start the gateway${_CLR_RESET}"
|
||||
echo -e "${_CLR_CYAN} 2.${_CLR_RESET} $(_cmd clawdock-fix-token) ${_CLR_DIM}# Configure token${_CLR_RESET}"
|
||||
echo -e "${_CLR_CYAN} 3.${_CLR_RESET} $(_cmd clawdock-dashboard) ${_CLR_DIM}# Open web UI${_CLR_RESET}"
|
||||
echo -e "${_CLR_CYAN} 4.${_CLR_RESET} $(_cmd clawdock-devices) ${_CLR_DIM}# If pairing needed${_CLR_RESET}"
|
||||
echo -e "${_CLR_CYAN} 5.${_CLR_RESET} $(_cmd clawdock-approve) ${_CLR_CYAN}<id>${_CLR_RESET} ${_CLR_DIM}# Approve pairing${_CLR_RESET}"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_GREEN}💬 WhatsApp Setup${_CLR_RESET}"
|
||||
echo -e " $(_cmd clawdock-shell)"
|
||||
echo -e " ${_CLR_BLUE}>${_CLR_RESET} $(_cmd 'openclaw channels login --channel whatsapp')"
|
||||
echo -e " ${_CLR_BLUE}>${_CLR_RESET} $(_cmd 'openclaw status')"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_BOLD}${_CLR_CYAN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${_CLR_RESET}"
|
||||
echo ""
|
||||
|
||||
echo -e "${_CLR_CYAN}💡 All commands guide you through next steps!${_CLR_RESET}"
|
||||
echo -e "${_CLR_BLUE}📚 Docs: ${_CLR_RESET}${_CLR_CYAN}https://docs.openclaw.ai${_CLR_RESET}"
|
||||
echo ""
|
||||
}
|
||||
Reference in New Issue
Block a user