mirror of
https://github.com/openclaw/openclaw.git
synced 2026-08-12 21:53:00 -06:00
docs: normalize frontmatter titles to sentence case
This commit is contained in:
Vincent Koc
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Auth Credential Semantics"
|
||||
title: "Auth credential semantics"
|
||||
summary: "Canonical credential eligibility and resolution semantics for auth profiles"
|
||||
read_when:
|
||||
- Working on auth profile resolution or credential routing
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
summary: "Redirect to /gateway/authentication"
|
||||
title: "Auth Monitoring"
|
||||
title: "Auth monitoring"
|
||||
---
|
||||
|
||||
This page moved to [Authentication](/gateway/authentication). See [Authentication](/gateway/authentication) for auth monitoring documentation.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Scheduling background jobs or wakeups
|
||||
- Wiring external triggers (webhooks, Gmail) into OpenClaw
|
||||
- Deciding between heartbeat and cron for scheduled tasks
|
||||
title: "Scheduled Tasks"
|
||||
title: "Scheduled tasks"
|
||||
---
|
||||
|
||||
# Scheduled Tasks (Cron)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
summary: "Redirect to /automation"
|
||||
title: "Cron vs Heartbeat"
|
||||
title: "Cron vs heartbeat"
|
||||
---
|
||||
|
||||
This page moved to [Automation & Tasks](/automation). See [Automation & Tasks](/automation) for the decision guide comparing cron and heartbeat.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Deciding how to automate work with OpenClaw
|
||||
- Choosing between heartbeat, cron, hooks, and standing orders
|
||||
- Looking for the right automation entry point
|
||||
title: "Automation & Tasks"
|
||||
title: "Automation & tasks"
|
||||
---
|
||||
|
||||
OpenClaw runs work in the background through tasks, scheduled jobs, event hooks, and standing instructions. This page helps you choose the right mechanism and understand how they fit together.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Setting up autonomous agent workflows that run without per-task prompting
|
||||
- Defining what the agent can do independently vs. what needs human approval
|
||||
- Structuring multi-program agents with clear boundaries and escalation rules
|
||||
title: "Standing Orders"
|
||||
title: "Standing orders"
|
||||
---
|
||||
|
||||
Standing orders grant your agent **permanent operating authority** for defined programs. Instead of giving individual task instructions each time, you define programs with clear scope, triggers, and escalation rules — and the agent executes autonomously within those boundaries.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to understand how Task Flow relates to background tasks
|
||||
- You encounter Task Flow or openclaw tasks flow in release notes or docs
|
||||
- You want to inspect or manage durable flow state
|
||||
title: "Task Flow"
|
||||
title: "Task flow"
|
||||
---
|
||||
|
||||
Task Flow is the flow orchestration substrate that sits above [background tasks](/automation/tasks). It manages durable multi-step flows with their own state, revision tracking, and sync semantics while individual tasks remain the unit of detached work.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Inspecting background work in progress or recently completed
|
||||
- Debugging delivery failures for detached agent runs
|
||||
- Understanding how background runs relate to sessions, cron, and heartbeat
|
||||
title: "Background Tasks"
|
||||
title: "Background tasks"
|
||||
---
|
||||
|
||||
> **Looking for scheduling?** See [Automation & Tasks](/automation) for choosing the right mechanism. This page covers **tracking** background work, not scheduling it.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
summary: "Redirect to /automation/cron-jobs"
|
||||
title: "Automation Troubleshooting"
|
||||
title: "Automation troubleshooting"
|
||||
---
|
||||
|
||||
This page moved to [Scheduled Tasks](/automation/cron-jobs#troubleshooting). See [Scheduled Tasks](/automation/cron-jobs#troubleshooting) for troubleshooting documentation.
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Brave Search API setup for web_search"
|
||||
read_when:
|
||||
- You want to use Brave Search for web_search
|
||||
- You need a BRAVE_API_KEY or plan details
|
||||
title: "Brave Search (legacy path)"
|
||||
title: "Brave search (legacy path)"
|
||||
---
|
||||
|
||||
# Brave Search API
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Configuring broadcast groups
|
||||
- Debugging multi-agent replies in WhatsApp
|
||||
status: experimental
|
||||
title: "Broadcast Groups"
|
||||
title: "Broadcast groups"
|
||||
---
|
||||
|
||||
**Status:** Experimental
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "Routing rules per channel (WhatsApp, Telegram, Discord, Slack) and shared context"
|
||||
read_when:
|
||||
- Changing channel routing or inbox behavior
|
||||
title: "Channel Routing"
|
||||
title: "Channel routing"
|
||||
---
|
||||
|
||||
# Channels & routing
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "Behavior and config for WhatsApp group message handling (mentionPatterns are shared across surfaces)"
|
||||
read_when:
|
||||
- Changing group message rules or mentions
|
||||
title: "Group Messages"
|
||||
title: "Group messages"
|
||||
---
|
||||
|
||||
# Group messages (WhatsApp web channel)
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Messaging platforms OpenClaw can connect to"
|
||||
read_when:
|
||||
- You want to choose a chat channel for OpenClaw
|
||||
- You need a quick overview of supported messaging platforms
|
||||
title: "Chat Channels"
|
||||
title: "Chat channels"
|
||||
---
|
||||
|
||||
OpenClaw can talk to you on any chat app you already use. Each channel connects via the Gateway.
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Inbound channel location parsing (Telegram/WhatsApp/Matrix) and contex
|
||||
read_when:
|
||||
- Adding or modifying channel location parsing
|
||||
- Using location context fields in agent prompts or tools
|
||||
title: "Channel Location Parsing"
|
||||
title: "Channel location parsing"
|
||||
---
|
||||
|
||||
OpenClaw normalizes shared locations from chat channels into:
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "QA Channel"
|
||||
title: "QA channel"
|
||||
summary: "Synthetic Slack-class channel plugin for deterministic OpenClaw QA scenarios"
|
||||
read_when:
|
||||
- You are wiring the synthetic QA transport into a local or CI test run
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to connect OpenClaw to QQ
|
||||
- You need QQ Bot credential setup
|
||||
- You want QQ Bot group or private chat support
|
||||
title: QQ Bot
|
||||
title: QQ bot
|
||||
---
|
||||
|
||||
QQ Bot connects to OpenClaw via the official QQ Bot API (WebSocket gateway). The
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Fast channel level troubleshooting with per channel failure signatures
|
||||
read_when:
|
||||
- Channel transport says connected but replies fail
|
||||
- You need channel specific checks before deep provider docs
|
||||
title: "Channel Troubleshooting"
|
||||
title: "Channel troubleshooting"
|
||||
---
|
||||
|
||||
Use this page when a channel connects but behavior is wrong.
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Zalo personal account support via native zca-js (QR login), capabiliti
|
||||
read_when:
|
||||
- Setting up Zalo Personal for OpenClaw
|
||||
- Debugging Zalo Personal login or message flow
|
||||
title: "Zalo Personal"
|
||||
title: "Zalo personal"
|
||||
---
|
||||
|
||||
# Zalo Personal (unofficial)
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: CI Pipeline
|
||||
title: CI pipeline
|
||||
summary: "CI job graph, scope gates, and local command equivalents"
|
||||
read_when:
|
||||
- You need to understand why a CI job did or did not run
|
||||
|
||||
+1
-1
@@ -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.
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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:
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
+1
-1
@@ -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`
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Active Memory"
|
||||
title: "Active memory"
|
||||
summary: "A plugin-owned blocking memory sub-agent that injects relevant memory into interactive chat sessions"
|
||||
read_when:
|
||||
- You want to understand what active memory is for
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Agent loop lifecycle, streams, and wait semantics"
|
||||
read_when:
|
||||
- You need an exact walkthrough of the agent loop or lifecycle events
|
||||
- You are changing session queueing, transcript writes, or session write lock behavior
|
||||
title: "Agent Loop"
|
||||
title: "Agent loop"
|
||||
---
|
||||
|
||||
# Agent Loop (OpenClaw)
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Agent workspace: location, layout, and backup strategy"
|
||||
read_when:
|
||||
- You need to explain the agent workspace or its file layout
|
||||
- You want to back up or migrate an agent workspace
|
||||
title: "Agent Workspace"
|
||||
title: "Agent workspace"
|
||||
---
|
||||
|
||||
The workspace is the agent's home. It is the only working directory used for
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "Agent runtime, workspace contract, and session bootstrap"
|
||||
read_when:
|
||||
- Changing agent runtime, workspace bootstrap, or session behavior
|
||||
title: "Agent Runtime"
|
||||
title: "Agent runtime"
|
||||
---
|
||||
|
||||
OpenClaw runs a single embedded agent runtime.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "WebSocket gateway architecture, components, and client flows"
|
||||
read_when:
|
||||
- Working on gateway protocol, clients, or transports
|
||||
title: "Gateway Architecture"
|
||||
title: "Gateway architecture"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to understand how OpenClaw assembles model context
|
||||
- You are switching between the legacy engine and a plugin engine
|
||||
- You are building a context engine plugin
|
||||
title: "Context Engine"
|
||||
title: "Context engine"
|
||||
---
|
||||
|
||||
A **context engine** controls how OpenClaw builds model context for each run.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
summary: "Delegate architecture: running OpenClaw as a named agent on behalf of an organization"
|
||||
title: Delegate Architecture
|
||||
title: Delegate architecture
|
||||
read_when: "You want an agent with its own identity that acts on behalf of humans in an organization."
|
||||
status: active
|
||||
---
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Experimental Features"
|
||||
title: "Experimental features"
|
||||
summary: "What experimental flags mean in OpenClaw and which ones are currently documented"
|
||||
read_when:
|
||||
- You see an `.experimental` config key and want to know whether it is stable
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You are changing markdown formatting or chunking for outbound channels
|
||||
- You are adding a new channel formatter or style mapping
|
||||
- You are debugging formatting regressions across channels
|
||||
title: "Markdown Formatting"
|
||||
title: "Markdown formatting"
|
||||
---
|
||||
|
||||
OpenClaw formats outbound Markdown by converting it into a shared intermediate
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Builtin Memory Engine"
|
||||
title: "Builtin memory engine"
|
||||
summary: "The default SQLite-based memory backend with keyword, vector, and hybrid search"
|
||||
read_when:
|
||||
- You want to understand the default memory backend
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Honcho Memory"
|
||||
title: "Honcho memory"
|
||||
summary: "AI-native cross-session memory via the Honcho plugin"
|
||||
read_when:
|
||||
- You want persistent memory that works across sessions and channels
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "QMD Memory Engine"
|
||||
title: "QMD memory engine"
|
||||
summary: "Local-first search sidecar with BM25, vectors, reranking, and query expansion"
|
||||
read_when:
|
||||
- You want to set up QMD as your memory backend
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Memory Search"
|
||||
title: "Memory search"
|
||||
summary: "How memory search finds relevant notes using embeddings and hybrid retrieval"
|
||||
read_when:
|
||||
- You want to understand how memory_search works
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Memory Overview"
|
||||
title: "Memory overview"
|
||||
summary: "How OpenClaw remembers things across sessions"
|
||||
read_when:
|
||||
- You want to understand how memory works
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Diagnosing auth profile rotation, cooldowns, or model fallback behavior
|
||||
- Updating failover rules for auth profiles or models
|
||||
- Understanding how session model overrides interact with fallback retries
|
||||
title: "Model Failover"
|
||||
title: "Model failover"
|
||||
---
|
||||
|
||||
OpenClaw handles failures in two stages:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
summary: "Multi-agent routing: isolated agents, channel accounts, and bindings"
|
||||
title: Multi-Agent Routing
|
||||
title: Multi-agent routing
|
||||
read_when: "You want multiple isolated agents (workspaces + auth) in one gateway process."
|
||||
status: active
|
||||
---
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Extending qa-lab or qa-channel
|
||||
- Adding repo-backed QA scenarios
|
||||
- Building higher-realism QA automation around the Gateway dashboard
|
||||
title: "QA E2E Automation"
|
||||
title: "QA E2E automation"
|
||||
---
|
||||
|
||||
The private QA stack is meant to exercise OpenClaw in a more realistic,
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "Command queue design that serializes inbound auto-reply runs"
|
||||
read_when:
|
||||
- Changing auto-reply execution or concurrency
|
||||
title: "Command Queue"
|
||||
title: "Command queue"
|
||||
---
|
||||
|
||||
# Command Queue (2026-01-16)
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Retry policy for outbound provider calls"
|
||||
read_when:
|
||||
- Updating provider retry behavior or defaults
|
||||
- Debugging provider send errors or rate limits
|
||||
title: "Retry Policy"
|
||||
title: "Retry policy"
|
||||
---
|
||||
|
||||
## Goals
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Session Pruning"
|
||||
title: "Session pruning"
|
||||
summary: "Trimming old tool results to keep context lean and caching efficient"
|
||||
read_when:
|
||||
- You want to reduce context growth from tool outputs
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want to understand what session tools the agent has
|
||||
- You want to configure cross-session access or sub-agent spawning
|
||||
- You want to inspect status or control spawned sub-agents
|
||||
title: "Session Tools"
|
||||
title: "Session tools"
|
||||
---
|
||||
|
||||
OpenClaw gives agents tools to work across sessions, inspect status, and
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "How OpenClaw manages conversation sessions"
|
||||
read_when:
|
||||
- You want to understand session routing and isolation
|
||||
- You want to configure DM scope for multi-user setups
|
||||
title: "Session Management"
|
||||
title: "Session management"
|
||||
---
|
||||
|
||||
OpenClaw organizes conversations into **sessions**. Each message is routed to a
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- You want your agent to sound less generic
|
||||
- You are editing SOUL.md
|
||||
- You want a stronger personality without breaking safety or brevity
|
||||
title: "SOUL.md Personality Guide"
|
||||
title: "SOUL.md personality guide"
|
||||
---
|
||||
|
||||
`SOUL.md` is where your agent's voice lives.
|
||||
|
||||
@@ -4,7 +4,7 @@ read_when:
|
||||
- Explaining how streaming or chunking works on channels
|
||||
- Changing block streaming or channel chunking behavior
|
||||
- Debugging duplicate/early block replies or channel preview streaming
|
||||
title: "Streaming and Chunking"
|
||||
title: "Streaming and chunking"
|
||||
---
|
||||
|
||||
# Streaming + chunking
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "What the OpenClaw system prompt contains and how it is assembled"
|
||||
read_when:
|
||||
- Editing system prompt text, tools list, or time/heartbeat sections
|
||||
- Changing workspace bootstrap or skills injection behavior
|
||||
title: "System Prompt"
|
||||
title: "System prompt"
|
||||
---
|
||||
|
||||
OpenClaw builds a custom system prompt for every agent run. The prompt is **OpenClaw-owned** and does not use the pi-coding-agent default prompt.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
summary: "When OpenClaw shows typing indicators and how to tune them"
|
||||
read_when:
|
||||
- Changing typing indicator behavior or defaults
|
||||
title: "Typing Indicators"
|
||||
title: "Typing indicators"
|
||||
---
|
||||
|
||||
Typing indicators are sent to the chat channel while a run is active. Use
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Usage tracking surfaces and credential requirements"
|
||||
read_when:
|
||||
- You are wiring provider usage/quota surfaces
|
||||
- You need to explain usage tracking behavior or auth requirements
|
||||
title: "Usage Tracking"
|
||||
title: "Usage tracking"
|
||||
---
|
||||
|
||||
## What it is
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ summary: "Date and time handling across envelopes, prompts, tools, and connector
|
||||
read_when:
|
||||
- You are changing how timestamps are shown to the model or users
|
||||
- You are debugging time formatting in messages or system prompt output
|
||||
title: "Date and Time"
|
||||
title: "Date and time"
|
||||
---
|
||||
|
||||
# Date & Time
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: Node + tsx "__name is not a function" crash notes and workarounds
|
||||
read_when:
|
||||
- Debugging Node-only dev scripts or watch mode failures
|
||||
- Investigating tsx/esbuild loader crashes in OpenClaw
|
||||
title: "Node + tsx Crash"
|
||||
title: "Node + tsx crash"
|
||||
---
|
||||
|
||||
# Node + tsx "\_\_name is not a function" crash
|
||||
|
||||
@@ -3,7 +3,7 @@ summary: "Diagnostics flags for targeted debug logs"
|
||||
read_when:
|
||||
- You need targeted debug logs without raising global logging levels
|
||||
- You need to capture subsystem-specific logs for support
|
||||
title: "Diagnostics Flags"
|
||||
title: "Diagnostics flags"
|
||||
---
|
||||
|
||||
Diagnostics flags let you enable targeted debug logs without turning on verbose logging everywhere. Flags are opt-in and have no effect unless a subsystem checks them.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user