Files
crabwalk/public/skill.md
T
Luciano Castillo 27d0afd736 Add crabwalk CLI (#30)
* feat: add crabwalk CLI

- bin/crabwalk: shell wrapper with start/stop/status/update commands
- daemon mode with --daemon flag
- auto-detect gateway token from ~/.clawdbot/clawdbot.json
- show network IPs on startup for remote access
- update skill.md and README with CLI usage

* auto-add ~/.local/bin to PATH during install

* support zsh PATH config
2026-02-01 15:24:33 -05:00

3.6 KiB

name, version, description, homepage, repository, metadata
name version description homepage repository metadata
crabwalk 1.0.7 Real-time companion monitor for OpenClaw agents https://crabwalk.app https://github.com/luccast/crabwalk
emoji category
🦀 monitoring

Crabwalk 🦀

Real-time companion monitor for OpenClaw agents. Visualize agent sessions, tool calls, and activity in a reactive graph UI.

Install

# Download latest release
VERSION=$(curl -s https://api.github.com/repos/luccast/crabwalk/releases/latest | grep '"tag_name"' | cut -d'"' -f4)
mkdir -p ~/.crabwalk
curl -sL "https://github.com/luccast/crabwalk/releases/download/${VERSION}/crabwalk-${VERSION}.tar.gz" | tar -xz -C ~/.crabwalk

# Install CLI
mkdir -p ~/.local/bin
cp ~/.crabwalk/bin/crabwalk ~/.local/bin/crabwalk
chmod +x ~/.local/bin/crabwalk

# Add to PATH if needed
if ! echo $PATH | grep -q "$HOME/.local/bin"; then
  [ -f ~/.bashrc ] && echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
  [ -f ~/.zshrc ] && echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
  export PATH="$HOME/.local/bin:$PATH"
fi

One-Liner Install

VERSION=$(curl -s https://api.github.com/repos/luccast/crabwalk/releases/latest | grep '"tag_name"' | cut -d'"' -f4) && mkdir -p ~/.crabwalk ~/.local/bin && curl -sL "https://github.com/luccast/crabwalk/releases/download/${VERSION}/crabwalk-${VERSION}.tar.gz" | tar -xz -C ~/.crabwalk && cp ~/.crabwalk/bin/crabwalk ~/.local/bin/ && chmod +x ~/.local/bin/crabwalk && (echo $PATH | grep -q "$HOME/.local/bin" || ([ -f ~/.bashrc ] && echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc; [ -f ~/.zshrc ] && echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc; export PATH="$HOME/.local/bin:$PATH")) && echo "🦀 Crabwalk ${VERSION} installed"

CLI Usage

crabwalk                    # Start server (0.0.0.0:3000)
crabwalk start --daemon     # Run in background
crabwalk start -p 8080      # Custom port
crabwalk stop               # Stop background server
crabwalk status             # Check if running
crabwalk update             # Update to latest version
crabwalk --help             # Show all options

CLI Options

Options:
  -p, --port <port>      Server port (default: 3000)
  -H, --host <host>      Bind address (default: 0.0.0.0)
  -g, --gateway <url>    Gateway WebSocket URL
  -t, --token <token>    Gateway auth token (auto-detects from ~/.clawdbot/clawdbot.json)
  -d, --daemon           Run in background
  -v, --version          Show version
  -h, --help             Show help

Features

  • /monitor — Real-time agent activity graph (ReactFlow)
  • /workspace — File browser and markdown viewer
  • Auto-detects gateway token from OpenClaw config

Requirements

  • Node.js 20+
  • OpenClaw gateway running on ws://127.0.0.1:18789

Check for Updates

crabwalk update

This checks for updates and prompts before installing.

Updating

IMPORTANT: Always ask user permission before updating.

If update available, ask user:

"Crabwalk update available (X.X.X -> Y.Y.Y). See release: https://github.com/luccast/crabwalk/releases/tag/vY.Y.Y — Update now?"

Only proceed if user confirms. Run:

crabwalk update

Or manually:

VERSION=$(curl -s https://api.github.com/repos/luccast/crabwalk/releases/latest | grep '"tag_name"' | cut -d'"' -f4)
rm -rf ~/.crabwalk/.output
curl -sL "https://github.com/luccast/crabwalk/releases/download/${VERSION}/crabwalk-${VERSION}.tar.gz" | tar -xz -C ~/.crabwalk
cp ~/.crabwalk/bin/crabwalk ~/.local/bin/crabwalk
echo "🦀 Updated to ${VERSION}"

Verify Installation

crabwalk --version
crabwalk status

Repository: https://github.com/luccast/crabwalk