Crabbox

https://openclaw.github.io/crabbox/
Admin
Crabbox is a shared agent workspace control plane that enables developers and AI agents to lease...
Tokens:1,526
Snippets:21
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Crabbox using Homebrew

Source: https://openclaw.github.io/crabbox

Install the Crabbox CLI using the Homebrew package manager. Verify the installation with `crabbox --version`.

```bash
brew install openclaw/tap/crabboxCopy
```

--------------------------------

### Validate local configuration and environment

Source: https://openclaw.github.io/crabbox

Run `crabbox doctor` to check your local setup, including network connectivity and SSH keys, before starting a workflow. This helps prevent issues during execution.

```bash
crabbox doctor
```

--------------------------------

### Build and serve the documentation site locally

Source: https://openclaw.github.io/crabbox

Execute `npm run docs:check` to build the documentation site. The output is then served locally, and you can access it via the provided URL.

```bash
npm run docs:check
open dist/docs-site/index.html
```

--------------------------------

### Run a command on a leased box

Source: https://openclaw.github.io/crabbox

Execute a command on a newly leased remote box. The output and status are streamed back.

```bash
$ crabbox run -- pnpm test
# lease cbx_8f2 - hetzner cax21 - ready 11s
# sync 184 files (1.2 MB)
# tests passed in 47s - released
```

--------------------------------

### One-shot run with Crabbox

Source: https://openclaw.github.io/crabbox

Perform a one-shot run on a fresh leased box. This command is useful for quick tests or single executions.

```bash
# one-shot run on a fresh leased box
crabbox run -- pnpm test
```

--------------------------------

### Warm up a Crabbox instance

Source: https://openclaw.github.io/crabbox

Use this command to keep a warm box ready for repeated runs. The output includes an ID and slug for the instance.

```bash
crabbox warmup
```

--------------------------------

### Summarize resource usage

Source: https://openclaw.github.io/crabbox

Use `crabbox usage` to view a summary of recent resource consumption, broken down by user, organization, provider, and server type. This is helpful for cost management and monitoring.

```bash
crabbox usage
```

--------------------------------

### Run a task with a specific ID

Source: https://openclaw.github.io/crabbox

Execute a task using a pre-warmed box identified by an ID. This command is useful for running specific tests or commands within a managed environment.

```bash
crabbox run --id blue-lobster -- pnpm test:changed
```

--------------------------------

### Log in to Crabbox

Source: https://openclaw.github.io/crabbox

Log in to the Crabbox service to store a broker token in your user configuration. This is typically done once per machine.

```bash
# log in once per machine - stores a broker token in user config
crabbox login
```

--------------------------------

### Connect to a Crabbox instance via SSH

Source: https://openclaw.github.io/crabbox

Access a running Crabbox instance through SSH using its ID. This allows for interactive debugging or manual operations within the instance.

```bash
crabbox ssh --id blue-lobster
```

--------------------------------

### Stop a Crabbox instance

Source: https://openclaw.github.io/crabbox

Terminate a running Crabbox instance using its ID or slug. This command frees up resources associated with the instance.

```bash
crabbox stop blue-lobster
```
Tokens:
Raw