Docs: add nav titles across docs (#5689)
parent
1295b67057
commit
abcaa8c7a9
|
|
@ -3,6 +3,7 @@ summary: "Monitor OAuth expiry for model providers"
|
|||
read_when:
|
||||
- Setting up auth expiry monitoring or alerts
|
||||
- Automating Claude Code / Codex OAuth refresh checks
|
||||
title: "Auth Monitoring"
|
||||
---
|
||||
|
||||
# Auth monitoring
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- Scheduling background jobs or wakeups
|
||||
- Wiring automation that should run with or alongside heartbeats
|
||||
- Deciding between heartbeat and cron for scheduled tasks
|
||||
title: "Cron Jobs"
|
||||
---
|
||||
|
||||
# Cron jobs (Gateway scheduler)
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- Deciding how to schedule recurring tasks
|
||||
- Setting up background monitoring or notifications
|
||||
- Optimizing token usage for periodic checks
|
||||
title: "Cron vs Heartbeat"
|
||||
---
|
||||
|
||||
# Cron vs Heartbeat: When to Use Each
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Gmail Pub/Sub push wired into OpenClaw webhooks via gogcli"
|
|||
read_when:
|
||||
- Wiring Gmail inbox triggers to OpenClaw
|
||||
- Setting up Pub/Sub push for agent wake
|
||||
title: "Gmail PubSub"
|
||||
---
|
||||
|
||||
# Gmail Pub/Sub -> OpenClaw
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Poll sending via gateway + CLI"
|
|||
read_when:
|
||||
- Adding or modifying poll support
|
||||
- Debugging poll sends from the CLI or gateway
|
||||
title: "Polls"
|
||||
---
|
||||
|
||||
# Polls
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Webhook ingress for wake and isolated agent runs"
|
|||
read_when:
|
||||
- Adding or changing webhook endpoints
|
||||
- Wiring external systems into OpenClaw
|
||||
title: "Webhooks"
|
||||
---
|
||||
|
||||
# Webhooks
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Use Amazon Bedrock (Converse API) models with OpenClaw"
|
|||
read_when:
|
||||
- You want to use Amazon Bedrock models with OpenClaw
|
||||
- You need AWS credential/region setup for model calls
|
||||
title: "Amazon Bedrock"
|
||||
---
|
||||
|
||||
# Amazon Bedrock
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# Brave Search API
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- Configuring broadcast groups
|
||||
- Debugging multi-agent replies in WhatsApp
|
||||
status: experimental
|
||||
title: "Broadcast Groups"
|
||||
---
|
||||
|
||||
# Broadcast Groups
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- Setting up BlueBubbles channel
|
||||
- Troubleshooting webhook pairing
|
||||
- Configuring iMessage on macOS
|
||||
title: "BlueBubbles"
|
||||
---
|
||||
|
||||
# BlueBubbles (macOS REST)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Discord bot support status, capabilities, and configuration"
|
||||
read_when:
|
||||
- Working on Discord channel features
|
||||
title: "Discord"
|
||||
---
|
||||
|
||||
# Discord (Bot API)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Google Chat app support status, capabilities, and configuration"
|
||||
read_when:
|
||||
- Working on Google Chat channel features
|
||||
title: "Google Chat"
|
||||
---
|
||||
|
||||
# Google Chat (Chat API)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Telegram Bot API integration via grammY with setup notes"
|
||||
read_when:
|
||||
- Working on Telegram or grammY pathways
|
||||
title: grammY
|
||||
---
|
||||
|
||||
# grammY Integration (Telegram Bot API)
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "iMessage support via imsg (JSON-RPC over stdio), setup, and chat_id ro
|
|||
read_when:
|
||||
- Setting up iMessage support
|
||||
- Debugging iMessage send/receive
|
||||
title: iMessage
|
||||
---
|
||||
|
||||
# iMessage (imsg)
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# Chat Channels
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- You want to connect OpenClaw to LINE
|
||||
- You need LINE webhook + credential setup
|
||||
- You want LINE-specific message options
|
||||
title: LINE
|
||||
---
|
||||
|
||||
# LINE (plugin)
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Inbound channel location parsing (Telegram + WhatsApp) and context fie
|
|||
read_when:
|
||||
- Adding or modifying channel location parsing
|
||||
- Using location context fields in agent prompts or tools
|
||||
title: "Channel Location Parsing"
|
||||
---
|
||||
|
||||
# Channel location parsing
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Matrix support status, capabilities, and configuration"
|
||||
read_when:
|
||||
- Working on Matrix channel features
|
||||
title: "Matrix"
|
||||
---
|
||||
|
||||
# Matrix (plugin)
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Mattermost bot setup and OpenClaw config"
|
|||
read_when:
|
||||
- Setting up Mattermost
|
||||
- Debugging Mattermost routing
|
||||
title: "Mattermost"
|
||||
---
|
||||
|
||||
# Mattermost (plugin)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Microsoft Teams bot support status, capabilities, and configuration"
|
||||
read_when:
|
||||
- Working on MS Teams channel features
|
||||
title: "Microsoft Teams"
|
||||
---
|
||||
|
||||
# Microsoft Teams (plugin)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Nextcloud Talk support status, capabilities, and configuration"
|
||||
read_when:
|
||||
- Working on Nextcloud Talk channel features
|
||||
title: "Nextcloud Talk"
|
||||
---
|
||||
|
||||
# Nextcloud Talk (plugin)
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Nostr DM channel via NIP-04 encrypted messages"
|
|||
read_when:
|
||||
- You want OpenClaw to receive DMs via Nostr
|
||||
- You're setting up decentralized messaging
|
||||
title: "Nostr"
|
||||
---
|
||||
|
||||
# Nostr
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Signal support via signal-cli (JSON-RPC + SSE), setup, and number mode
|
|||
read_when:
|
||||
- Setting up Signal support
|
||||
- Debugging Signal send/receive
|
||||
title: "Signal"
|
||||
---
|
||||
|
||||
# Signal (signal-cli)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
summary: "Slack setup for socket or HTTP webhook mode"
|
||||
read_when: "Setting up Slack or debugging Slack socket/HTTP mode"
|
||||
title: "Slack"
|
||||
---
|
||||
|
||||
# Slack
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Telegram bot support status, capabilities, and configuration"
|
||||
read_when:
|
||||
- Working on Telegram features or webhooks
|
||||
title: "Telegram"
|
||||
---
|
||||
|
||||
# Telegram (Bot API)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Tlon/Urbit support status, capabilities, and configuration"
|
||||
read_when:
|
||||
- Working on Tlon/Urbit channel features
|
||||
title: "Tlon"
|
||||
---
|
||||
|
||||
# Tlon (plugin)
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Channel-specific troubleshooting shortcuts (Discord/Telegram/WhatsApp)
|
|||
read_when:
|
||||
- A channel connects but messages don’t flow
|
||||
- Investigating channel misconfiguration (intents, permissions, privacy mode)
|
||||
title: "Channel Troubleshooting"
|
||||
---
|
||||
|
||||
# Channel troubleshooting
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Twitch chat bot configuration and setup"
|
||||
read_when:
|
||||
- Setting up Twitch chat integration for OpenClaw
|
||||
title: "Twitch"
|
||||
---
|
||||
|
||||
# Twitch (plugin)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "WhatsApp (web channel) integration: login, inbox, replies, media, and ops"
|
||||
read_when:
|
||||
- Working on WhatsApp/web channel behavior or inbox routing
|
||||
title: "WhatsApp"
|
||||
---
|
||||
|
||||
# WhatsApp (web channel)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Zalo bot support status, capabilities, and configuration"
|
||||
read_when:
|
||||
- Working on Zalo features or webhooks
|
||||
title: "Zalo"
|
||||
---
|
||||
|
||||
# Zalo (Bot API)
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Zalo personal account support via zca-cli (QR login), capabilities, an
|
|||
read_when:
|
||||
- Setting up Zalo Personal for OpenClaw
|
||||
- Debugging Zalo Personal login or message flow
|
||||
title: "Zalo Personal"
|
||||
---
|
||||
|
||||
# Zalo Personal (unofficial)
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# acp
|
||||
|
|
|
|||
|
|
@ -2,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw agent`
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "CLI reference for `openclaw agents` (list/add/delete/set identity)"
|
||||
read_when:
|
||||
- You want multiple isolated agents (workspaces + routing + auth)
|
||||
title: "agents"
|
||||
---
|
||||
|
||||
# `openclaw agents`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw approvals` (exec approvals for gateway or
|
|||
read_when:
|
||||
- You want to edit exec approvals from the CLI
|
||||
- You need to manage allowlists on gateway or node hosts
|
||||
title: "approvals"
|
||||
---
|
||||
|
||||
# `openclaw approvals`
|
||||
|
|
|
|||
|
|
@ -4,6 +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 use the Chrome extension relay (attach/detach via toolbar button)
|
||||
title: "browser"
|
||||
---
|
||||
|
||||
# `openclaw browser`
|
||||
|
|
|
|||
|
|
@ -3,6 +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)
|
||||
- You want to check channel status or tail channel logs
|
||||
title: "channels"
|
||||
---
|
||||
|
||||
# `openclaw channels`
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "CLI reference for `openclaw config` (get/set/unset config values)"
|
||||
read_when:
|
||||
- You want to read or edit config non-interactively
|
||||
title: "config"
|
||||
---
|
||||
|
||||
# `openclaw config`
|
||||
|
|
|
|||
|
|
@ -2,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw configure`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw cron`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw dashboard`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw devices`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw directory`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw dns`
|
||||
|
|
|
|||
|
|
@ -2,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw docs`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw doctor`
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- Running the Gateway from the CLI (dev or servers)
|
||||
- Debugging Gateway auth, bind modes, and connectivity
|
||||
- Discovering gateways via Bonjour (LAN + tailnet)
|
||||
title: "gateway"
|
||||
---
|
||||
|
||||
# Gateway CLI
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "CLI reference for `openclaw health` (gateway health endpoint via RPC)"
|
||||
read_when:
|
||||
- You want to quickly check the running Gateway’s health
|
||||
title: "health"
|
||||
---
|
||||
|
||||
# `openclaw health`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw hooks` (agent hooks)"
|
|||
read_when:
|
||||
- You want to manage agent hooks
|
||||
- You want to install or update hooks
|
||||
title: "hooks"
|
||||
---
|
||||
|
||||
# `openclaw hooks`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "OpenClaw CLI reference for `openclaw` commands, subcommands, and optio
|
|||
read_when:
|
||||
- Adding or modifying CLI commands or options
|
||||
- Documenting new command surfaces
|
||||
title: "CLI Reference"
|
||||
---
|
||||
|
||||
# CLI reference
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw logs`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw memory` (status/index/search)"
|
|||
read_when:
|
||||
- You want to index or search semantic memory
|
||||
- You’re debugging memory availability or indexing
|
||||
title: "memory"
|
||||
---
|
||||
|
||||
# `openclaw memory`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw message`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw models`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw node`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw nodes` (list/status/approve/invoke, camera
|
|||
read_when:
|
||||
- You’re managing paired nodes (cameras, screen, canvas)
|
||||
- You need to approve requests or invoke node commands
|
||||
title: "nodes"
|
||||
---
|
||||
|
||||
# `openclaw nodes`
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "CLI reference for `openclaw onboard` (interactive onboarding wizard)"
|
||||
read_when:
|
||||
- You want guided setup for gateway, workspace, auth, channels, and skills
|
||||
title: "onboard"
|
||||
---
|
||||
|
||||
# `openclaw onboard`
|
||||
|
|
|
|||
|
|
@ -2,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw pairing`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw plugins` (list, install, enable/disable, d
|
|||
read_when:
|
||||
- You want to install or manage in-process Gateway plugins
|
||||
- You want to debug plugin load failures
|
||||
title: "plugins"
|
||||
---
|
||||
|
||||
# `openclaw plugins`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw reset`
|
||||
|
|
|
|||
|
|
@ -3,6 +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 (chmod, tighten defaults)
|
||||
title: "security"
|
||||
---
|
||||
|
||||
# `openclaw security`
|
||||
|
|
|
|||
|
|
@ -2,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw sessions`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw setup` (initialize config + workspace)"
|
|||
read_when:
|
||||
- You’re doing first-run setup without the full onboarding wizard
|
||||
- You want to set the default workspace path
|
||||
title: "setup"
|
||||
---
|
||||
|
||||
# `openclaw setup`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw skills` (list/info/check) and skill eligib
|
|||
read_when:
|
||||
- You want to see which skills are available and ready to run
|
||||
- You want to debug missing binaries/env/config for skills
|
||||
title: "skills"
|
||||
---
|
||||
|
||||
# `openclaw skills`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw status`
|
||||
|
|
|
|||
|
|
@ -4,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw system`
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "CLI reference for `openclaw tui` (terminal UI connected to the Gateway
|
|||
read_when:
|
||||
- You want a terminal UI for the Gateway (remote-friendly)
|
||||
- You want to pass url/token/session from scripts
|
||||
title: "tui"
|
||||
---
|
||||
|
||||
# `openclaw tui`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw uninstall`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw update`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw voicecall`
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# `openclaw webhooks`
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Agent loop lifecycle, streams, and wait semantics"
|
||||
read_when:
|
||||
- You need an exact walkthrough of the agent loop or lifecycle events
|
||||
title: "Agent Loop"
|
||||
---
|
||||
|
||||
# Agent Loop (OpenClaw)
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# Agent workspace
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Agent runtime (embedded pi-mono), workspace contract, and session bootstrap"
|
||||
read_when:
|
||||
- Changing agent runtime, workspace bootstrap, or session behavior
|
||||
title: "Agent Runtime"
|
||||
---
|
||||
|
||||
# Agent Runtime 🤖
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "WebSocket gateway architecture, components, and client flows"
|
||||
read_when:
|
||||
- Working on gateway protocol, clients, or transports
|
||||
title: "Gateway Architecture"
|
||||
---
|
||||
|
||||
# Gateway architecture
|
||||
|
|
|
|||
|
|
@ -2,6 +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"
|
||||
---
|
||||
|
||||
# Channels & routing
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Context window + compaction: how OpenClaw keeps sessions under model l
|
|||
read_when:
|
||||
- You want to understand auto-compaction and /compact
|
||||
- You are debugging long sessions hitting context limits
|
||||
title: "Compaction"
|
||||
---
|
||||
|
||||
# Context Window & Compaction
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- You want to understand what “context” means in OpenClaw
|
||||
- You are debugging why the model “knows” something (or forgot it)
|
||||
- You want to reduce context overhead (/context, /status, /compact)
|
||||
title: "Context"
|
||||
---
|
||||
|
||||
# Context
|
||||
|
|
|
|||
|
|
@ -2,6 +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"
|
||||
---
|
||||
|
||||
# Group messages (WhatsApp web channel)
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Group chat behavior across surfaces (WhatsApp/Telegram/Discord/Slack/Signal/iMessage/Microsoft Teams)"
|
||||
read_when:
|
||||
- Changing group chat behavior or mention gating
|
||||
title: "Groups"
|
||||
---
|
||||
|
||||
# Groups
|
||||
|
|
|
|||
|
|
@ -4,6 +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"
|
||||
---
|
||||
|
||||
# Markdown formatting
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "How OpenClaw memory works (workspace files + automatic memory flush)"
|
|||
read_when:
|
||||
- You want the memory file layout and workflow
|
||||
- You want to tune the automatic pre-compaction memory flush
|
||||
title: "Memory"
|
||||
---
|
||||
|
||||
# Memory
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- Explaining how inbound messages become replies
|
||||
- Clarifying sessions, queueing modes, or streaming behavior
|
||||
- Documenting reasoning visibility and usage implications
|
||||
title: "Messages"
|
||||
---
|
||||
|
||||
# Messages
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "How OpenClaw rotates auth profiles and falls back across models"
|
|||
read_when:
|
||||
- Diagnosing auth profile rotation, cooldowns, or model fallback behavior
|
||||
- Updating failover rules for auth profiles or models
|
||||
title: "Model Failover"
|
||||
---
|
||||
|
||||
# Model failover
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Model provider overview with example configs + CLI flows"
|
|||
read_when:
|
||||
- You need a provider-by-provider model setup reference
|
||||
- You want example configs or CLI onboarding commands for model providers
|
||||
title: "Model Providers"
|
||||
---
|
||||
|
||||
# Model providers
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- Adding or modifying models CLI (models list/set/scan/aliases/fallbacks)
|
||||
- Changing model fallback behavior or selection UX
|
||||
- Updating model scan probes (tools/images)
|
||||
title: "Models CLI"
|
||||
---
|
||||
|
||||
# Models CLI
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ read_when:
|
|||
- You hit token invalidation / logout issues
|
||||
- You want setup-token or OAuth auth flows
|
||||
- You want multiple accounts or profile routing
|
||||
title: "OAuth"
|
||||
---
|
||||
|
||||
# OAuth
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ read_when:
|
|||
- Debugging the Instances tab
|
||||
- Investigating duplicate or stale instance rows
|
||||
- Changing gateway WS connect or system-event beacons
|
||||
title: "Presence"
|
||||
---
|
||||
|
||||
# Presence
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Command queue design that serializes inbound auto-reply runs"
|
||||
read_when:
|
||||
- Changing auto-reply execution or concurrency
|
||||
title: "Command Queue"
|
||||
---
|
||||
|
||||
# Command Queue (2026-01-16)
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# Retry policy
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Session pruning: tool-result trimming to reduce context bloat"
|
|||
read_when:
|
||||
- You want to reduce LLM context growth from tool outputs
|
||||
- You are tuning agents.defaults.contextPruning
|
||||
title: "Session Pruning"
|
||||
---
|
||||
|
||||
# Session Pruning
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Agent session tools for listing sessions, fetching history, and sending cross-session messages"
|
||||
read_when:
|
||||
- Adding or modifying session tools
|
||||
title: "Session Tools"
|
||||
---
|
||||
|
||||
# Session Tools
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Session management rules, keys, and persistence for chats"
|
||||
read_when:
|
||||
- Modifying session handling or storage
|
||||
title: "Session Management"
|
||||
---
|
||||
|
||||
# Session Management
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "Alias for session management docs"
|
||||
read_when:
|
||||
- You looked for docs/sessions.md; canonical doc lives in docs/session.md
|
||||
title: "Sessions"
|
||||
---
|
||||
|
||||
# Sessions
|
||||
|
|
|
|||
|
|
@ -4,6 +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 draft streaming
|
||||
title: "Streaming and Chunking"
|
||||
---
|
||||
|
||||
# Streaming + chunking
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# System Prompt
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ summary: "Timezone handling for agents, envelopes, and prompts"
|
|||
read_when:
|
||||
- You need to understand how timestamps are normalized for the model
|
||||
- Configuring the user timezone for system prompts
|
||||
title: "Timezones"
|
||||
---
|
||||
|
||||
# Timezones
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "TypeBox schemas as the single source of truth for the gateway protocol"
|
||||
read_when:
|
||||
- Updating protocol schemas or codegen
|
||||
title: "TypeBox"
|
||||
---
|
||||
|
||||
# TypeBox as protocol source of truth
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
summary: "When OpenClaw shows typing indicators and how to tune them"
|
||||
read_when:
|
||||
- Changing typing indicator behavior or defaults
|
||||
title: "Typing Indicators"
|
||||
---
|
||||
|
||||
# Typing indicators
|
||||
|
|
|
|||
|
|
@ -3,6 +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"
|
||||
---
|
||||
|
||||
# Usage tracking
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue