mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 08:20:43 +00:00
docs: normalize frontmatter titles to sentence case
This commit is contained in:
Vincent Koc
@@ -3,7 +3,7 @@ summary: "Run the ACP bridge for IDE integrations"
|
||||
read_when:
|
||||
- Setting up ACP-based IDE integrations
|
||||
- Debugging ACP session routing to the Gateway
|
||||
title: "acp"
|
||||
title: "ACP"
|
||||
---
|
||||
|
||||
Run the [Agent Client Protocol (ACP)](https://agentclientprotocol.com/) bridge that talks to an OpenClaw Gateway.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw agent` (send one agent turn via the Gateway)"
|
||||
read_when:
|
||||
- You want to run one agent turn from scripts (optionally deliver reply)
|
||||
title: "agent"
|
||||
title: "Agent"
|
||||
---
|
||||
|
||||
# `openclaw agent`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw agents` (list/add/delete/bindings/bind/unbind/set identity)"
|
||||
read_when:
|
||||
- You want multiple isolated agents (workspaces + routing + auth)
|
||||
title: "agents"
|
||||
title: "Agents"
|
||||
---
|
||||
|
||||
# `openclaw agents`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw approvals` and `openclaw exec-policy`"
|
||||
read_when:
|
||||
- You want to edit exec approvals from the CLI
|
||||
- You need to manage allowlists on gateway or node hosts
|
||||
title: "approvals"
|
||||
title: "Approvals"
|
||||
---
|
||||
|
||||
# `openclaw approvals`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw backup` (create local backup archives)"
|
||||
read_when:
|
||||
- You want a first-class backup archive for local OpenClaw state
|
||||
- You want to preview which paths would be included before reset or uninstall
|
||||
title: "backup"
|
||||
title: "Backup"
|
||||
---
|
||||
|
||||
# `openclaw backup`
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You use `openclaw browser` and want examples for common tasks
|
||||
- You want to control a browser running on another machine via a node host
|
||||
- You want to attach to your local signed-in Chrome via Chrome MCP
|
||||
title: "browser"
|
||||
title: "Browser"
|
||||
---
|
||||
|
||||
# `openclaw browser`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw channels` (accounts, status, login/logout,
|
||||
read_when:
|
||||
- You want to add/remove channel accounts (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/Matrix)
|
||||
- You want to check channel status or tail channel logs
|
||||
title: "channels"
|
||||
title: "Channels"
|
||||
---
|
||||
|
||||
# `openclaw channels`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw clawbot` (legacy alias namespace)"
|
||||
read_when:
|
||||
- You maintain older scripts using `openclaw clawbot ...`
|
||||
- You need migration guidance to current commands
|
||||
title: "clawbot"
|
||||
title: "Clawbot"
|
||||
---
|
||||
|
||||
# `openclaw clawbot`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw completion` (generate/install shell comple
|
||||
read_when:
|
||||
- You want shell completions for zsh/bash/fish/PowerShell
|
||||
- You need to cache completion scripts under OpenClaw state
|
||||
title: "completion"
|
||||
title: "Completion"
|
||||
---
|
||||
|
||||
# `openclaw completion`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw config` (get/set/unset/file/schema/validate)"
|
||||
read_when:
|
||||
- You want to read or edit config non-interactively
|
||||
title: "config"
|
||||
title: "Config"
|
||||
---
|
||||
|
||||
# `openclaw config`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw configure` (interactive configuration prompts)"
|
||||
read_when:
|
||||
- You want to tweak credentials, devices, or agent defaults interactively
|
||||
title: "configure"
|
||||
title: "Configure"
|
||||
---
|
||||
|
||||
# `openclaw configure`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw cron` (schedule and run background jobs)"
|
||||
read_when:
|
||||
- You want scheduled jobs and wakeups
|
||||
- You’re debugging cron execution and logs
|
||||
title: "cron"
|
||||
title: "Cron"
|
||||
---
|
||||
|
||||
# `openclaw cron`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw daemon` (legacy alias for gateway service
|
||||
read_when:
|
||||
- You still use `openclaw daemon ...` in scripts
|
||||
- You need service lifecycle commands (install/start/stop/restart/status)
|
||||
title: "daemon"
|
||||
title: "Daemon"
|
||||
---
|
||||
|
||||
# `openclaw daemon`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw dashboard` (open the Control UI)"
|
||||
read_when:
|
||||
- You want to open the Control UI with your current token
|
||||
- You want to print the URL without launching a browser
|
||||
title: "dashboard"
|
||||
title: "Dashboard"
|
||||
---
|
||||
|
||||
# `openclaw dashboard`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw devices` (device pairing + token rotation/
|
||||
read_when:
|
||||
- You are approving device pairing requests
|
||||
- You need to rotate or revoke device tokens
|
||||
title: "devices"
|
||||
title: "Devices"
|
||||
---
|
||||
|
||||
# `openclaw devices`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw directory` (self, peers, groups)"
|
||||
read_when:
|
||||
- You want to look up contacts/groups/self ids for a channel
|
||||
- You are developing a channel directory adapter
|
||||
title: "directory"
|
||||
title: "Directory"
|
||||
---
|
||||
|
||||
# `openclaw directory`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw dns` (wide-area discovery helpers)"
|
||||
read_when:
|
||||
- You want wide-area discovery (DNS-SD) via Tailscale + CoreDNS
|
||||
- You’re setting up split DNS for a custom discovery domain (example: openclaw.internal)
|
||||
title: "dns"
|
||||
title: "DNS"
|
||||
---
|
||||
|
||||
# `openclaw dns`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw docs` (search the live docs index)"
|
||||
read_when:
|
||||
- You want to search the live OpenClaw docs from the terminal
|
||||
title: "docs"
|
||||
title: "Docs"
|
||||
---
|
||||
|
||||
# `openclaw docs`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw doctor` (health checks + guided repairs)"
|
||||
read_when:
|
||||
- You have connectivity/auth issues and want guided fixes
|
||||
- You updated and want a sanity check
|
||||
title: "doctor"
|
||||
title: "Doctor"
|
||||
---
|
||||
|
||||
# `openclaw doctor`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "Redirect: flow commands live under `openclaw tasks flow`"
|
||||
read_when:
|
||||
- You encounter openclaw flows in older docs or release notes
|
||||
title: "flows (redirect)"
|
||||
title: "Flows (redirect)"
|
||||
---
|
||||
|
||||
# `openclaw tasks flow`
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Running the Gateway from the CLI (dev or servers)
|
||||
- Debugging Gateway auth, bind modes, and connectivity
|
||||
- Discovering gateways via Bonjour (local + wide-area DNS-SD)
|
||||
title: "gateway"
|
||||
title: "Gateway"
|
||||
---
|
||||
|
||||
# Gateway CLI
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw health` (gateway health snapshot via RPC)"
|
||||
read_when:
|
||||
- You want to quickly check the running Gateway’s health
|
||||
title: "health"
|
||||
title: "Health"
|
||||
---
|
||||
|
||||
# `openclaw health`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw hooks` (agent hooks)"
|
||||
read_when:
|
||||
- You want to manage agent hooks
|
||||
- You want to inspect hook availability or enable workspace hooks
|
||||
title: "hooks"
|
||||
title: "Hooks"
|
||||
---
|
||||
|
||||
# `openclaw hooks`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "OpenClaw CLI index: command list, global flags, and links to per-comma
|
||||
read_when:
|
||||
- Finding the right `openclaw` subcommand
|
||||
- Looking up global flags or output styling rules
|
||||
title: "CLI Reference"
|
||||
title: "CLI reference"
|
||||
---
|
||||
|
||||
`openclaw` is the main CLI entry point. Each core command has either a
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw logs` (tail gateway logs via RPC)"
|
||||
read_when:
|
||||
- You need to tail Gateway logs remotely (without SSH)
|
||||
- You want JSON log lines for tooling
|
||||
title: "logs"
|
||||
title: "Logs"
|
||||
---
|
||||
|
||||
# `openclaw logs`
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Connecting Codex, Claude Code, or another MCP client to OpenClaw-backed channels
|
||||
- Running `openclaw mcp serve`
|
||||
- Managing OpenClaw-saved MCP server definitions
|
||||
title: "mcp"
|
||||
title: "MCP"
|
||||
---
|
||||
|
||||
`openclaw mcp` has two jobs:
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to index or search semantic memory
|
||||
- You’re debugging memory availability or indexing
|
||||
- You want to promote recalled short-term memory into `MEMORY.md`
|
||||
title: "memory"
|
||||
title: "Memory"
|
||||
---
|
||||
|
||||
# `openclaw memory`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw message` (send + channel actions)"
|
||||
read_when:
|
||||
- Adding or modifying message CLI actions
|
||||
- Changing outbound channel behavior
|
||||
title: "message"
|
||||
title: "Message"
|
||||
---
|
||||
|
||||
# `openclaw message`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw models` (status/list/set/scan, aliases, fa
|
||||
read_when:
|
||||
- You want to change default models or view provider auth status
|
||||
- You want to scan available models/providers and debug auth profiles
|
||||
title: "models"
|
||||
title: "Models"
|
||||
---
|
||||
|
||||
# `openclaw models`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw node` (headless node host)"
|
||||
read_when:
|
||||
- Running the headless node host
|
||||
- Pairing a non-macOS node for system.run
|
||||
title: "node"
|
||||
title: "Node"
|
||||
---
|
||||
|
||||
# `openclaw node`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw nodes` (status, pairing, invoke, camera/ca
|
||||
read_when:
|
||||
- You’re managing paired nodes (cameras, screen, canvas)
|
||||
- You need to approve requests or invoke node commands
|
||||
title: "nodes"
|
||||
title: "Nodes"
|
||||
---
|
||||
|
||||
# `openclaw nodes`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw onboard` (interactive onboarding)"
|
||||
read_when:
|
||||
- You want guided setup for gateway, workspace, auth, channels, and skills
|
||||
title: "onboard"
|
||||
title: "Onboard"
|
||||
---
|
||||
|
||||
# `openclaw onboard`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw pairing` (approve/list pairing requests)"
|
||||
read_when:
|
||||
- You’re using pairing-mode DMs and need to approve senders
|
||||
title: "pairing"
|
||||
title: "Pairing"
|
||||
---
|
||||
|
||||
# `openclaw pairing`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw plugins` (list, install, marketplace, unin
|
||||
read_when:
|
||||
- You want to install or manage Gateway plugins or compatible bundles
|
||||
- You want to debug plugin load failures
|
||||
title: "plugins"
|
||||
title: "Plugins"
|
||||
---
|
||||
|
||||
# `openclaw plugins`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw proxy`, the local debug proxy and capture
|
||||
read_when:
|
||||
- You need to capture OpenClaw transport traffic locally for debugging
|
||||
- You want to inspect debug proxy sessions, blobs, or built-in query presets
|
||||
title: "proxy"
|
||||
title: "Proxy"
|
||||
---
|
||||
|
||||
# `openclaw proxy`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw qr` (generate mobile pairing QR + setup co
|
||||
read_when:
|
||||
- You want to pair a mobile node app with a gateway quickly
|
||||
- You need setup-code output for remote/manual sharing
|
||||
title: "qr"
|
||||
title: "QR"
|
||||
---
|
||||
|
||||
# `openclaw qr`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw reset` (reset local state/config)"
|
||||
read_when:
|
||||
- You want to wipe local state while keeping the CLI installed
|
||||
- You want a dry-run of what would be removed
|
||||
title: "reset"
|
||||
title: "Reset"
|
||||
---
|
||||
|
||||
# `openclaw reset`
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Re-resolving secret refs at runtime
|
||||
- Auditing plaintext residues and unresolved refs
|
||||
- Configuring SecretRefs and applying one-way scrub changes
|
||||
title: "secrets"
|
||||
title: "Secrets"
|
||||
---
|
||||
|
||||
# `openclaw secrets`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw security` (audit and fix common security f
|
||||
read_when:
|
||||
- You want to run a quick security audit on config/state
|
||||
- You want to apply safe “fix” suggestions (permissions, tighten defaults)
|
||||
title: "security"
|
||||
title: "Security"
|
||||
---
|
||||
|
||||
# `openclaw security`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "CLI reference for `openclaw sessions` (list stored sessions + usage)"
|
||||
read_when:
|
||||
- You want to list stored sessions and see recent activity
|
||||
title: "sessions"
|
||||
title: "Sessions"
|
||||
---
|
||||
|
||||
# `openclaw sessions`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw setup` (initialize config + workspace)"
|
||||
read_when:
|
||||
- You’re doing first-run setup without full CLI onboarding
|
||||
- You want to set the default workspace path
|
||||
title: "setup"
|
||||
title: "Setup"
|
||||
---
|
||||
|
||||
# `openclaw setup`
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to see which skills are available and ready to run
|
||||
- You want to search, install, or update skills from ClawHub
|
||||
- You want to debug missing binaries/env/config for skills
|
||||
title: "skills"
|
||||
title: "Skills"
|
||||
---
|
||||
|
||||
# `openclaw skills`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw status` (diagnostics, probes, usage snapsh
|
||||
read_when:
|
||||
- You want a quick diagnosis of channel health + recent session recipients
|
||||
- You want a pasteable “all” status for debugging
|
||||
title: "status"
|
||||
title: "Status"
|
||||
---
|
||||
|
||||
# `openclaw status`
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to enqueue a system event without creating a cron job
|
||||
- You need to enable or disable heartbeats
|
||||
- You want to inspect system presence entries
|
||||
title: "system"
|
||||
title: "System"
|
||||
---
|
||||
|
||||
# `openclaw system`
|
||||
|
||||
@@ -5,7 +5,7 @@ read_when:
|
||||
- You want to pass url/token/session from scripts
|
||||
- You want to run the TUI in local embedded mode without a Gateway
|
||||
- You want to use openclaw chat or openclaw tui --local
|
||||
title: "tui"
|
||||
title: "TUI"
|
||||
---
|
||||
|
||||
# `openclaw tui`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw uninstall` (remove gateway service + local
|
||||
read_when:
|
||||
- You want to remove the gateway service and/or local state
|
||||
- You want a dry-run first
|
||||
title: "uninstall"
|
||||
title: "Uninstall"
|
||||
---
|
||||
|
||||
# `openclaw uninstall`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw update` (safe-ish source update + gateway
|
||||
read_when:
|
||||
- You want to update a source checkout safely
|
||||
- You need to understand `--update` shorthand behavior
|
||||
title: "update"
|
||||
title: "Update"
|
||||
---
|
||||
|
||||
# `openclaw update`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw voicecall` (voice-call plugin command surf
|
||||
read_when:
|
||||
- You use the voice-call plugin and want the CLI entry points
|
||||
- You want quick examples for `voicecall call|continue|status|tail|expose`
|
||||
title: "voicecall"
|
||||
title: "Voicecall"
|
||||
---
|
||||
|
||||
# `openclaw voicecall`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw webhooks` (webhook helpers + Gmail Pub/Sub
|
||||
read_when:
|
||||
- You want to wire Gmail Pub/Sub events into OpenClaw
|
||||
- You want webhook helper commands
|
||||
title: "webhooks"
|
||||
title: "Webhooks"
|
||||
---
|
||||
|
||||
# `openclaw webhooks`
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "CLI reference for `openclaw wiki` (memory-wiki vault status, search, c
|
||||
read_when:
|
||||
- You want to use the memory-wiki CLI
|
||||
- You are documenting or changing `openclaw wiki`
|
||||
title: "wiki"
|
||||
title: "Wiki"
|
||||
---
|
||||
|
||||
# `openclaw wiki`
|
||||
|
||||
Reference in New Issue
Block a user