OpenClaw

https://docs.openclaw.ai/concepts
Admin
OpenClaw is an open-source, self-hosted gateway connecting chat apps like Discord, Slack, Telegram,...
Tokens:287,313
Snippets:2,259
Trust Score:5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install and setup OpenClaw Honcho plugin

Source: https://docs.openclaw.ai/concepts/memory-honcho.md

Run these commands to install the plugin, run setup, and start the gateway. The setup command prompts for API credentials, writes the config, and optionally migrates existing workspace memory files. The API key is only needed for the managed API at api.honcho.dev; self-hosted deployments have no key to enter.

```bash
openclaw plugins install @honcho-ai/openclaw-honcho
openclaw honcho setup
openclaw gateway --force
```

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

### Install the OpenClaw Gateway service (openclaw gateway install)

Source: https://docs.openclaw.ai

Installs the Gateway as a background service after pressing Ctrl+C to stop the foreground Gateway started by quick start.

```bash
openclaw gateway install
```

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

### Run slack-desktop-smoke Mantis QA scenario with gateway setup

Source: https://docs.openclaw.ai/concepts/mantis.md

Leases or reuses a Crabbox desktop, syncs the checkout, runs Slack QA inside the VM, opens Slack Web in the VNC browser, and copies artifacts back. With --gateway-setup, it creates a persistent OpenClaw home and starts the gateway; without it, runs the normal bot-to-bot Slack QA lane.

```bash
pnpm openclaw qa mantis slack-desktop-smoke \
  --output-dir .artifacts/qa-e2e/mantis/slack-desktop \
  --gateway-setup \
  --scenario slack-canary \
  --keep-lease
```

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

### Example flow with verbose and trace

Source: https://docs.openclaw.ai/concepts/active-memory/session-controls.md

Example commands to see active memory status and debug summary in a chat.

```text
/verbose on
/trace on
what wings should i order?
```

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

### Install context engine plugin from local path

Source: https://docs.openclaw.ai/concepts/context-engine.md

Install a context engine plugin from a local path using the `-l` flag.

```bash
openclaw plugins install -l ./my-context-engine
```

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

### Run QA Lab with pnpm qa:lab:up

Source: https://docs.openclaw.ai/concepts/qa-e2e-automation/operator-flow.md

Starts the QA Lab environment: builds the QA site, starts the Docker-backed gateway lane, and exposes the QA Lab page for operator or automation use.

```bash
pnpm qa:lab:up
```

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

### BytePlus ARK plugin installation and restart

Source: https://docs.openclaw.ai/concepts/model-providers/custom-providers.md

Commands to install the official BytePlus provider plugin and restart the Gateway. Required before using the byteplus provider.

```bash
openclaw plugins install @openclaw/byteplus-provider
openclaw gateway restart
```

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

### Install context engine plugin from npm

Source: https://docs.openclaw.ai/concepts/context-engine.md

Install a context engine plugin from npm using `openclaw plugins install`.

```bash
openclaw plugins install @martian-engineering/lossless-claw
```

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

### ClawSweeper proof command examples

Source: https://docs.openclaw.ai/concepts/mantis.md

Example invocations of the `@clawsweeper proof` command, which can be used once the integration is deployed. The command accepts optional proof types, including comma-separated lists.

```text
@clawsweeper proof
@clawsweeper proof web-ui-chat-proof
@clawsweeper proof telegram-bot-e2e-proof
@clawsweeper proof web-ui-chat-proof,telegram-bot-e2e-proof
```

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

### Recommended starter configuration for active-memory plugin

Source: https://docs.openclaw.ai/concepts/active-memory/recommended-setup.md

Starter configuration for the active-memory plugin using 'recent' query mode and 'escalate' mode. Includes 'timeoutMs: 15000' and 'setupGraceTimeoutMs' is not set, so the default behavior applies. Use '/verbose on' and '/trace on' for tuning.

```json5
{
  plugins: {
    entries: {
      "active-memory": {
        enabled: true,
        config: {
          agents: ["main"],
          mode: "escalate",
          queryMode: "recent",
          promptStyle: "balanced",
          timeoutMs: 15000,
          maxSummaryChars: 220,
          logging: true,
        },
      },
    },
  },
}
```

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

### Install OpenClaw with curl (macOS/Linux/WSL2) and PowerShell (Windows)

Source: https://docs.openclaw.ai

Installs OpenClaw on macOS/Linux/WSL2 (bash) and Windows (PowerShell). The installer detects the OS, installs Node if needed, installs OpenClaw, and starts onboarding.

```bash
curl -fsSL https://openclaw.ai/install.sh | bash
```

```powershell
iwr -useb https://openclaw.ai/install.ps1 | iex
```

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

### Configure messages.queue with JSON5

Source: https://docs.openclaw.ai/concepts/queue.md

Example configuration for setting queue mode, cap, drop policy, and per-channel overrides. Both maps accept channel IDs from bundled and installed plugins. Config validation warns about IDs absent from the channel registry.

```json5
{
  messages: {
    queue: {
      mode: "steer",
      cap: 20,
      drop: "summarize",
      byChannel: { discord: "collect", x: "followup" },
      debounceMsByChannel: { discord: 1000, x: 500 },
    },
  },
}
```

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

### Suggested .gitignore starter

Source: https://docs.openclaw.ai/concepts/agent-workspace.md

A starter .gitignore to avoid committing secrets and sensitive files. Includes .DS_Store, .env, key/pem files, and secrets directories.

```gitignore
.DS_Store
.env
**/*.key
**/*.pem
**/secrets*
```

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

### CLI commands for onboarding and model management

Source: https://docs.openclaw.ai/concepts/model-providers.md

Commands to onboard with opencode-zen, set a model, and list models.

```bash
openclaw onboard --auth-choice opencode-zen
openclaw models set opencode/claude-opus-4-6
openclaw models list
```

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

### Example retirement JSON request

Source: https://docs.openclaw.ai/concepts/managed-worktrees.md

Example JSON payload for the --exact-state option. Use actual observed values, not the example. Omit ownerId for a manual record without an owner ID. The fields include ownerKind, ownerId, createdAt, lastActiveAt, head, branchHead, and indexSha256.

```json
{
  "ownerKind": "session",
  "ownerId": "example-session",
  "createdAt": 1800000000000,
  "lastActiveAt": 1800000000001,
  "head": "1111111111111111111111111111111111111111",
  "branchHead": "2222222222222222222222222222222222222222",
  "indexSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
```

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

### Run desktop-browser-smoke Mantis QA scenario

Source: https://docs.openclaw.ai/concepts/mantis.md

Leases or reuses a Crabbox desktop, launches a browser in the VNC session, captures screenshots and optional video, and syncs artifacts back. Use --lease-id to reuse a warmed desktop, --browser-profile-dir to reuse a Chrome profile, and --keep-lease to keep the VM open for inspection.

```bash
pnpm openclaw qa mantis desktop-browser-smoke \
  --output-dir .artifacts/qa-e2e/mantis/desktop-browser
```

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

### Install llama.cpp provider for local embeddings

Source: https://docs.openclaw.ai/concepts/memory-builtin.md

Installs the official llama.cpp provider plugin, which is required to use local GGUF embeddings with the builtin memory engine.

```bash
openclaw plugins install @openclaw/llama-cpp-provider
```
Tokens:
Raw