OpenClaw Documentation Map: Browse All Docs Pages

OpenClaw docs map

This document is produced from docs/**/*.md and docs/**/*.mdx headings to help agents browse the documentation tree. Do not modify it directly; execute pnpm docs:map:gen instead.

agent-runtime-architecture.md

• Route: /agent-runtime-architecture
• Headings:
  • H2: Runtime Layout
  • H2: Boundaries
  • H2: Manifests
  • H2: Runtime Selection
  • H2: Model Runtime Generations
  • H2: Related

announcements/bluebubbles-imessage.md

• Route: /announcements/bluebubbles-imessage
• Headings:
  • H1: BlueBubbles removal and the imsg iMessage path
  • H2: What changed
  • H2: What to do
  • H2: Migration notes
  • H2: See also

auth-credential-semantics.md

• Route: /auth-credential-semantics
• Headings:
  • H2: Stable probe reason codes
  • H2: Token credentials
  • H3: Eligibility rules
  • H3: Resolution rules
  • H2: Agent copy portability
  • H2: Config-only auth routes
  • H2: Explicit auth order filtering
  • H2: Probe target resolution
  • H2: External CLI credential discovery
  • H2: OAuth SecretRef Policy Guard
  • H2: Legacy-Compatible Messaging
  • H2: Related

automation/auth-monitoring.md

• Route: /automation/auth-monitoring
• Headings:
  • H2: Related

automation/clawflow.md

• Route: /automation/clawflow
• Headings:
  • H2: Related

automation/cron-jobs.md

• Route: /automation/cron-jobs
• Headings:
  • H2: Quick start
  • H2: How cron works
  • H2: Schedule types
  • H3: Heartbeat task migration
  • H3: Stream sources
  • H3: Dynamic cadence (pacing)
  • H3: Day-of-month and day-of-week use OR logic
  • H2: Event triggers (condition watchers)
  • H2: Payloads
  • H3: Agent-turn options
  • H3: Command payloads
  • H3: Script payloads
  • H2: Execution styles
  • H2: Delivery and output
  • H3: Failure notifications
  • H3: Output language
  • H2: CLI examples
  • H2: Managing jobs
  • H2: Webhooks
  • H3: Authentication
  • H2: Gmail PubSub integration
  • H3: Wizard setup (recommended)
  • H3: Gateway auto-start
  • H3: Manual one-time setup
  • H3: Gmail model override
  • H2: Configuration
  • H2: Troubleshooting
  • H3: Command ladder
  • H2: Related

automation/cron-vs-heartbeat.md

• Route: /automation/cron-vs-heartbeat
• Headings:
  • H2: Related

automation/gmail-pubsub.md

• Route: /automation/gmail-pubsub
• Headings:
  • H2: Related

automation/hooks.md

• Route: /automation/hooks
• Headings:
  • H2: Choose the right surface
  • H2: Quick start
  • H2: Event types
  • H2: Writing hooks
  • H3: Hook structure
  • H3: HOOK.md format
  • H3: Handler implementation
  • H3: Event context highlights
  • H2: Hook discovery
  • H3: Hook packs
  • H2: Bundled hooks
  • H3: session-memory details
  • H3: bootstrap-extra-files config
  • H3: command-logger details
  • H3: compaction-notifier details
  • H3: boot-md details
  • H2: Plugin hooks
  • H2: Configuration
  • H2: CLI reference
  • H2: Best practices
  • H2: Troubleshooting
  • H3: Hook not discovered
  • H3: Hook not eligible
  • H3: Hook not executing
  • H2: Related

automation/index.md

• Route: /automation
• Headings:
  • H2: Quick decision guide
  • H3: Scheduled Tasks (Cron) vs Heartbeat
  • H2: Core concepts
  • H3: Scheduled tasks (cron)
  • H3: Tasks
  • H3: Task Flow
  • H3: Standing orders
  • H3: Hooks
  • H3: Heartbeat
  • H2: How they work together
  • H2: Related

automation/poll.md

• Route: /automation/poll
• Headings:
  • H2: Related

automation/standing-orders.md

• Route: /automation/standing-orders
• Headings:
  • H2: Why standing orders
  • H2: How they work
  • H2: Anatomy of a standing order
  • H2: Standing orders plus cron jobs
  • H2: Examples
  • H3: Example 1: content and social media (weekly cycle)
  • H3: Example 2: finance operations (event-triggered)
  • H3: Example 3: monitoring and alerts (continuous)
  • H2: Execute-verify-report pattern
  • H2: Multi-program architecture
  • H2: Best practices
  • H3: Do
  • H3: Avoid
  • H2: Related

automation/taskflow.md

• Route: /automation/taskflow
• Headings:
  • H2: When to use Task Flow
  • H2: Sync modes
  • H3: Managed mode
  • H3: Mirrored mode
  • H2: Flow statuses
  • H2: Durable state and revision tracking
  • H2: Cancel behavior
  • H2: CLI commands
  • H2: Reliable scheduled workflow pattern
  • H2: How flows relate to tasks
  • H2: Related

automation/tasks.md

• Route: /automation/tasks
• Headings:
  • H2: TL;DR
  • H2: Quick start
  • H2: What creates a task
  • H2: Task lifecycle
  • H2: Delivery and notifications
  • H3: Notification policies
  • H2: CLI reference
  • H2: Chat task board (/tasks)
  • H3: Control UI
  • H2: Status integration (task pressure)
  • H2: Storage and maintenance
  • H3: Where tasks live
  • H3: Automatic maintenance
  • H2: How tasks relate to other systems
  • H2: Related

automation/troubleshooting.md

• Route: /automation/troubleshooting
• Headings:
  • H2: Related

automation/webhook.md

• Route: /automation/webhook
• Headings:
  • H2: Related

brave-search.md

• Route: /brave-search
• Headings:
  • H2: Related

channels/access-groups.md

• Route: /channels/access-groups
• Headings:
  • H2: Static message sender groups
  • H2: Reference groups from allowlists
  • H2: Supported message-channel paths
  • H2: Discord channel audiences
  • H2: Plugin diagnostics
  • H2: Security notes
  • H2: Troubleshooting

channels/ambient-room-events.md

• Route: /channels/ambient-room-events
• Headings:
  • H2: Recommended setup
  • H2: What changes
  • H2: Discord example
  • H2: Slack example
  • H2: Telegram example
  • H2: Agent specific policy
  • H2: Visible reply modes
  • H2: History
  • H2: Troubleshooting
  • H2: Related

channels/bot-loop-protection.md

• Route: /channels/bot-loop-protection
• Headings:
  • H2: Defaults
  • H2: Configure shared defaults
  • H2: Override per channel, account, or room
  • H2: Channel support

channels/broadcast-groups.md

• Route: /channels/broadcast-groups
• Headings:
  • H2: Overview
  • H2: Configuration
  • H3: Basic setup
  • H3: Processing strategy
  • H3: Complete example
  • H2: How it works
  • H3: Message flow
  • H3: Session isolation
  • H3: Example: isolated sessions
  • H2: Use cases
  • H2: Best practices
  • H2: Compatibility
  • H3: Providers
  • H3: Routing
  • H2: Troubleshooting
  • H2: Examples
  • H2: API reference
  • H3: Config schema
  • H3: Fields
  • H2: Limitations
  • H2: Related

channels/channel-routing.md

• Route: /channels/channel-routing
• Headings:
  • H1: Channels & routing
  • H2: Key terms
  • H2: Outbound target prefixes
  • H2: Session key shapes (examples)
  • H2: Main DM route pinning
  • H2: Guarded inbound recording
  • H2: Routing rules (how an agent is chosen)
  • H2: Broadcast groups (run multiple agents)
  • H2: Config overview
  • H2: Session storage
  • H2: WebChat behavior
  • H2: Reply context
  • H2: Related

channels/clickclack.md

• Route: /channels/clickclack
• Headings:
  • H2: Quick setup
  • H3: Alternative: manual token
  • H3: Alternative: env-based token
  • H3: JSON5 reference
  • H3: Account config keys
  • H3: Keep an auth-gated public hostname
  • H2: Multiple bots
  • H2: Session discussions
  • H2: Reply modes
  • H2: Command menu
  • H2: Durable media delivery
  • H2: Agent activity rows
  • H2: Targets
  • H2: Permissions
  • H2: Troubleshooting

channels/discord-activities.md

• Route: /channels/discord-activities
• Headings:
  • H2: Prerequisites
  • H2: Setup
  • H2: Security model
  • H2: Troubleshooting
  • H3: The Activity says “Gateway offline”
  • H3: Discord opens a blank page or reports blocked:csp
  • H3: “Widget unavailable”
  • H3: “You cannot launch Activities in this channel”

channels/discord.md

• Route: /channels/discord
• Headings:
  • H2: Quick setup
  • H2: Recommended: Set up a guild workspace
  • H2: Runtime model
  • H2: Forum channels
  • H2: Interactive components
  • H2: Access control and routing
  • H3: Role-based agent routing
  • H2: Native commands and command auth
  • H2: Feature details
  • H2: Tools and action gates
  • H2: Components v2 UI
  • H2: Voice
  • H3: Voice channels
  • H3: Follow users in voice
  • H3: Voice messages
  • H2: Troubleshooting
  • H2: Configuration reference
  • H3: Discord Activities
  • H2: Safety and operations
  • H2: Related

channels/feishu.md

• Path: /channels/feishu
• Page structure:
  • H2: Quick start
  • H2: Inbound durability
  • H2: Access control
  • H3: Direct messages
  • H3: Group chats
  • H2: Group configuration examples
  • H3: Allow all groups, no @mention required
  • H3: Allow all groups, still require @mention
  • H3: Allow specific groups only
  • H3: Restrict senders within a group
  • H3: Bot-authored messages
  • H2: Get group/user IDs
  • H3: Group IDs (chat_id, format: oc_xxx)
  • H3: User IDs (open_id, format: ou_xxx)
  • H2: Common commands
  • H2: Troubleshooting
  • H3: Bot does not respond in group chats
  • H3: Bot does not receive messages
  • H3: QR setup does not react in the Feishu mobile app
  • H3: App Secret leaked
  • H2: Advanced configuration
  • H3: Multiple accounts
  • H3: Message limits
  • H3: Streaming
  • H3: Quota optimization
  • H3: Group session scope and topic threads
  • H3: Feishu workspace tools
  • H3: ACP sessions
  • H4: Persistent ACP binding
  • H4: Spawn ACP from chat
  • H3: Multi-agent routing
  • H2: Per-user agent isolation (Dynamic Agent Creation)
  • H3: Quick setup
  • H3: How it works
  • H3: Configuration options
  • H3: Session scope
  • H3: Typical multi-user deployment
  • H3: Verification
  • H3: Notes
  • H2: Configuration reference
  • H2: Supported message types
  • H3: Receive
  • H3: Send
  • H3: Threads and replies
  • H2: Related

channels/googlechat.md

• Path: /channels/googlechat
• Page structure:
  • H2: Install
  • H2: Quick setup (beginner)
  • H2: Add to Google Chat
  • H2: Public URL (Webhook-only)
  • H3: Option A: Tailscale Funnel (Recommended)
  • H3: Option B: Reverse Proxy (Caddy)
  • H3: Option C: Cloudflare Tunnel
  • H2: How it works
  • H3: Inbound durability
  • H2: Targets
  • H2: Config highlights
  • H2: Troubleshooting
  • H3: 405 Method Not Allowed
  • H3: Other issues
  • H2: Related

channels/group-messages.md

• Path: /channels/group-messages
• Page structure:
  • H2: Behavior
  • H2: Config example (WhatsApp)
  • H3: Activation command (owner-only)
  • H2: How to use
  • H2: Testing / verification
  • H2: Known considerations
  • H2: Related

channels/groups.md

• Path: /channels/groups
• Page structure:
  • H2: Beginner intro (2 minutes)
  • H2: Visible replies
  • H2: Context visibility and allowlists
  • H2: Session keys
  • H2: Pattern: personal DMs + public groups (single agent)
  • H2: Display labels
  • H2: Group policy
  • H2: Mention gating (default)
  • H2: Scope configured mention patterns
  • H2: Group/channel tool restrictions (optional)
  • H2: Group allowlists
  • H2: Activation (owner-only)
  • H2: Context fields
  • H2: iMessage specifics
  • H2: WhatsApp system prompts
  • H2: WhatsApp specifics
  • H2: Related

channels/imessage-from-bluebubbles.md

• Path: /channels/imessage-from-bluebubbles
• Page structure:
  • H2: Migration checklist
  • H2: What imsg does
  • H2: Before you start
  • H2: Config translation
  • H2: Group registry footgun
  • H2: Step-by-step
  • H2: Action parity at a glance
  • H2: Pairing, sessions, and ACP bindings
  • H2: No rollback channel
  • H2: Related

channels/imessage.md

• Path: /channels/imessage
• Page structure:
  • H2: Quick setup
  • H2: Requirements and permissions (macOS)
  • H2: Enabling the imsg private API
  • H3: Setup
  • H3: When SIP stays enabled
  • H2: Access control and routing
  • H2: ACP conversation bindings
  • H2: Deployment patterns
  • H2: Media, chunking, and delivery targets
  • H2: Private API actions
  • H2: Config writes
  • H2: Coalescing split-send DMs (command + URL in one composition)
  • H2: Inbound recovery after a bridge or gateway restart
  • H3: Operator-visible signal
  • H3: Migration
  • H2: Troubleshooting
  • H2: Configuration reference pointers
  • H2: Related

channels/index.md

• Path: /channels
• Page structure:
  • H2: Supported channels
  • H2: Delivery notes
  • H2: Notes

channels/irc.md

• Path: /channels/irc
• Page structure:
  • H2: Quick start
  • H2: Inbound durability
  • H2: Connection settings
  • H2: Security defaults
  • H2: Access control
  • H3: Common gotcha: allowFrom is for DMs, not channels
  • H2: Reply triggering (mentions)
  • H2: Security note (recommended for public channels)
  • H3: Same tools for everyone in the channel
  • H3: Different tools per sender (owner gets more power)
  • H2: NickServ
  • H2: Environment variables
  • H2: Troubleshooting
  • H2: Related

channels/line.md

• Path: /channels/line
• Page structure:
  • H2: Install
  • H2: Setup
  • H2: Configure
  • H2: Access control
  • H2: Message behavior
  • H2: Channel data (rich messages)
  • H2: ACP support
  • H2: Outbound media
  • H2: Troubleshooting
  • H2: Related

channels/location.md

• Path: /channels/location
• Page structure:
  • H2: Text formatting
  • H2: Context fields
  • H2: Outbound payloads
  • H2: Channel notes
  • H2: Related

channels/matrix-migration.md

• Path: /channels/matrix-migration
• Page structure:
  • H2: What the migration does automatically
  • H2: Upgrading from OpenClaw releases older than 2026.4
  • H2: Recommended upgrade flow
  • H2: Common messages and what they mean
  • H3: Manual recovery messages
  • H2: If encrypted history still does not come back
  • H2: If you want to start fresh for future messages
  • H2: Related

channels/matrix-presentation.md

• Path: /channels/matrix-presentation
• Page structure:
  • H2: Event content
  • H2: Fallback behavior
  • H2: Supported blocks
  • H2: Interactions
  • H2: Relationship to approval metadata
  • H2: Media messages

channels/matrix-push-rules.md

• Path: /channels/matrix-push-rules
• Page structure:
  • H2: Prerequisites
  • H2: Steps
  • H2: Multi-bot notes
  • H2: Homeserver notes
  • H2: Related

channels/matrix.md

• Path: /channels/matrix
• Page structure:
  • H2: Install
  • H2: Setup
  • H3: Interactive setup
  • H3: Minimal config
  • H3: Auto-join
  • H3: Allowlist target formats
  • H3: Account ID normalization
  • H3: Cached credentials
  • H3: Environment variables
  • H2: Configuration example
  • H2: Streaming previews
  • H2: Voice messages
  • H2: Approval metadata
  • H3: Self-hosted push rules for quiet finalized previews
  • H2: Bot-to-bot rooms
  • H2: Encryption and verification
  • H3: Enable encryption
  • H3: Status and trust signals
  • H3: Verify this device with a recovery key
  • H3: Bootstrap or repair cross-signing
  • H3: Room-key backup
  • H3: Listing, requesting, and responding to verifications
  • H3: Multi-account notes
  • H2: Profile management
  • H2: Threads
  • H3: Session routing (sessionScope)
  • H3: Reply threading (threadReplies)
  • H3: Thread inheritance and slash commands
  • H2: ACP conversation bindings
  • H3: Thread binding config
  • H2: Reactions
  • H2: History context
  • H2: Context visibility
  • H2: DM and room policy
  • H2: Direct room repair
  • H2: Exec approvals
  • H2: Slash commands
  • H2: Multi-account
  • H2: Private/LAN homeservers
  • H2: Proxying Matrix traffic
  • H2: Target resolution
  • H2: Configuration reference
  • H3: Account and connection
  • H3: Encryption
  • H3: Access and policy
  • H3: Reply behavior
  • H3: Reaction settings
  • H3: Tooling and per-room overrides
  • H3: Exec approval settings
  • H2: Related

channels/mattermost.md

• Path: /channels/mattermost
• Page structure:
  • H2: Install
  • H2: Quick setup
  • H2: Native slash commands
  • H2: Environment variables (default account)
  • H2: Chat modes
  • H2: Threading and sessions
  • H2: Access control (DMs)
  • H2: Channels (groups)
  • H2: Targets for outbound delivery
  • H2: DM channel retry
  • H2: Preview streaming
  • H2: Reactions (message tool)
  • H2: Interactive buttons (message tool)
  • H3: Direct API integration (external scripts)
  • H2: Directory adapter
  • H2: Multi-account
  • H2: Troubleshooting
  • H2: Related

channels/msteams.md

• Path: /channels/msteams
• Page structure:
  • H2: Bundled plugin
  • H2: Quick setup
  • H2: Goals
  • H2: Config writes
  • H2: Access control (DMs + groups)
  • H3: How it works
  • H3: Step 1: Create Azure Bot
  • H3: Step 2: Get credentials
  • H3: Step 3: Configure messaging endpoint
  • H3: Step 4: Enable Teams channel
  • H3: Step 5: Build Teams app manifest
  • H3: Step 6: Configure OpenClaw
  • H3: Step 7: Run the gateway
  • H2: Federated authentication (certificate plus managed identity)
  • H3: Option A: Certificate-based authentication
  • H3: Option B: Azure Managed Identity
  • H3: AKS Workload Identity setup
  • H3: Auth type comparison
  • H2: Local development (tunneling)
  • H2: Testing the bot
  • H2: Environment variables
  • H2: Member info action
  • H2: History context
  • H2: Current Teams RSC permissions (manifest)
  • H2: Example Teams manifest (redacted)
  • H3: Manifest caveats (must-have fields)
  • H3: Updating an existing app
  • H2: Capabilities: RSC only vs Graph
  • H3: With Teams RSC only (app installed, no Graph API permissions)
  • H3: With Teams RSC + Microsoft Graph Application permissions
  • H3: RSC vs Graph API
  • H2: Graph-enabled media + history
  • H3: Channel/group file recovery (graphMediaFallback)
  • H2: Known limitations
  • H3: Webhook timeouts
  • H3: Teams cloud and service URL support
  • H3: Formatting
  • H2: Configuration
  • H2: Routing and sessions
  • H2: Reply style: threads vs posts
  • H3: Resolution precedence
  • H3: Thread context preservation
  • H2: Attachments and images
  • H2: Sending files in group chats
  • H3: Why group chats need SharePoint
  • H3: Setup
  • H3: Sharing behavior
  • H3: Fallback behavior
  • H3: Files stored location
  • H2: Polls (Adaptive Cards)
  • H2: Presentation cards
  • H2: Target formats
  • H2: Proactive messaging
  • H2: Team and Channel IDs (Common Gotcha)
  • H2: Private channels
  • H2: Troubleshooting
  • H3: Common issues
  • H3: Manifest upload errors
  • H3: RSC permissions not working
  • H2: References
  • H2: Related

channels/nextcloud-talk.md

• Path: /channels/nextcloud-talk
• Sections:
  • H2: Install
  • H2: Quick setup (beginner)
  • H2: Notes
  • H2: Access control (DMs)
  • H2: Rooms (groups)
  • H2: Capabilities
  • H2: Configuration reference (Nextcloud Talk)
  • H2: Related

channels/nostr.md

• Path: /channels/nostr
• Sections:
  • H2: Install
  • H3: Non-interactive setup
  • H2: Quick setup
  • H2: Configuration reference
  • H2: Profile metadata
  • H2: Access control
  • H3: DM policies
  • H3: Allowlist example
  • H2: Key formats
  • H2: Relays
  • H2: Protocol support
  • H2: Testing
  • H3: Local relay
  • H3: Manual test
  • H2: Troubleshooting
  • H3: Not receiving messages
  • H3: Not sending responses
  • H3: Duplicate responses
  • H2: Security
  • H2: Limitations (MVP)
  • H2: Related

channels/pairing.md

• Path: /channels/pairing
• Sections:
  • H2: 1) DM pairing (inbound chat access)
  • H3: Approve from the Control UI
  • H3: Approve from the CLI
  • H3: Reusable sender groups
  • H3: Where the state lives
  • H2: 2) Node device pairing (iOS/Android/macOS/headless nodes)
  • H3: Pair from the Control UI (recommended)
  • H3: Pair via Telegram
  • H3: Approve a node device
  • H3: Optional trusted-CIDR node auto-approve
  • H3: Node pairing state storage
  • H3: Notes
  • H2: Related docs

channels/qa-channel.md

• Path: /channels/qa-channel
• Sections:
  • H2: What it does
  • H2: Config
  • H2: Runners
  • H2: Related

channels/qqbot.md

• Path: /channels/qqbot
• Sections:
  • H2: Install
  • H2: Setup
  • H2: Inbound durability
  • H2: Configure
  • H3: Streaming
  • H3: Access policy
  • H3: Multi-account setup
  • H3: Group chats
  • H3: Voice (STT / TTS)
  • H2: Target formats
  • H2: Slash commands
  • H2: Media and storage
  • H2: Troubleshooting
  • H2: Related

channels/raft.md

• Path: /channels/raft
• Sections:
  • H2: Install
  • H2: Prerequisites
  • H2: Configure
  • H2: How it works
  • H2: Verify
  • H2: Troubleshooting
  • H2: References

channels/reef.md

• Path: /channels/reef
• Sections:
  • H2: Quick start
  • H2: Agent-driven setup
  • H2: Configuration
  • H2: Adding a friend
  • H2: Sending and receiving
  • H2: Guards and owner review
  • H2: Troubleshooting

channels/signal.md

• Path: /channels/signal
• Sections:
  • H2: The number model (read this first)
  • H2: Install
  • H2: Quick setup
  • H2: What it is
  • H2: Setup path A: link existing Signal account (QR)
  • H2: Setup path B: register dedicated bot number (SMS, Linux)
  • H2: External native daemon mode
  • H2: Container mode (bbernhard/signal-cli-rest-api)
  • H2: Access control (DMs + groups)
  • H2: How it works (behavior)
  • H2: Media + limits
  • H2: Typing + read receipts
  • H2: Lifecycle status reactions
  • H2: Reactions (message tool)
  • H2: Approval reactions
  • H2: Question reactions
  • H2: Delivery targets (CLI/cron)
  • H2: Aliases
  • H2: Troubleshooting
  • H2: Security notes
  • H2: Configuration reference (Signal)
  • H2: Related

channels/slack.md

• Path: /channels/slack
• Sections:
  • H2: Choosing a transport
  • H3: Relay mode
  • H3: Enterprise Grid org-wide installs
  • H4: Socket Mode
  • H4: HTTP Request URLs
  • H2: Install
  • H2: Quick setup
  • H2: User identity (post as a real person)
  • H2: Socket Mode transport tuning
  • H2: Manifest and scope checklist
  • H3: Additional manifest settings
  • H2: Token model
  • H2: Actions and gates
  • H2: Access control and routing
  • H2: Threading, sessions, and reply tags
  • H2: Ack reactions
  • H3: Emoji (ackReaction)
  • H3: Scope (messages.ackReactionScope)
  • H2: Text streaming
  • H2: Typing reaction fallback
  • H2: Voice input
  • H2: Media, chunking, and delivery
  • H2: Commands and slash behavior
  • H2: Native charts
  • H2: Native tables
  • H2: Interactive replies
  • H3: Plugin-owned modal submissions
  • H2: Native approvals in Slack
  • H2: Events and operational behavior
  • H3: Presence events
  • H2: Configuration reference
  • H2: Troubleshooting
  • H2: Attachment media reference
  • H3: Supported media types
  • H3: Inbound pipeline
  • H3: Thread-root attachment inheritance
  • H3: Multi-attachment handling
  • H3: Size, download, and model limits
  • H3: Known limits
  • H3: Related documentation
  • H2: Related

channels/sms.md

• Path: /channels/sms
• Sections:
  • H2: Before you begin
  • H2: Quick Setup
  • H2: Configuration Examples
  • H3: Config file
  • H3: Environment variables
  • H3: SecretRef auth token
  • H3: Messaging Service sender
  • H3: Default outbound target
  • H2: Access control
  • H2: Sending SMS
  • H2: Verify Setup
  • H3: End-to-end test from macOS iMessage/SMS
  • H2: Webhook security
  • H2: Multi-account config
  • H2: Troubleshooting
  • H3: Twilio returns 403 or OpenClaw rejects the webhook
  • H3: No pairing request appears
  • H3: Outbound sends fail
  • H3: Messages arrive but the agent does not answer

channels/synology-chat.md

• Path: /channels/synology-chat
• Sections:
  • H2: Install
  • H2: Quick setup
  • H2: Inbound durability
  • H2: Environment variables
  • H2: DM policy and access control
  • H2: Outbound delivery
  • H2: Multi-account
  • H2: Security notes
  • H2: Troubleshooting
  • H2: Related

channels/telegram.md

• Path: /channels/telegram
• Sections:
  • H2: Quick setup
  • H2: Telegram side settings
  • H2: Dashboard Mini App
  • H2: Access control and activation
  • H3: Group bot identity
  • H2: Runtime behavior
  • H2: Feature reference
  • H2: Error reply controls
  • H2: Troubleshooting
  • H2: Configuration reference
  • H2: Related

channels/tlon.md

• Path: /channels/tlon
• Sections:
  • H2: Bundled plugin
  • H2: Setup
  • H2: Inbound durability
  • H2: Private/LAN ships
  • H2: Group channels
  • H2: Access control
  • H2: Owner and approval system
  • H2: Auto-accept settings
  • H2: Hot-reload via Urbit settings store
  • H2: Delivery targets (CLI/cron)
  • H2: Bundled skill
  • H2: Capabilities
  • H2: Troubleshooting
  • H2: Configuration reference
  • H2: Notes
  • H2: Related

channels/troubleshooting.md

• Path: /channels/troubleshooting
• Sections:
  • H2: Command ladder
  • H2: After an update
  • H2: WhatsApp
  • H3: WhatsApp failure signatures
  • H2: Telegram
  • H3: Telegram failure signatures
  • H2: Discord
  • H3: Discord failure signatures
  • H2: Slack
  • H3: Slack failure signatures
  • H2: iMessage
  • H3: iMessage failure signatures
  • H2: Signal
  • H3: Signal failure signatures
  • H2: QQ Bot
  • H3: QQ Bot failure signatures
  • H2: Matrix
  • H3: Matrix failure signatures
  • H2: Related

channels/twitch.md

• Path: /channels/twitch
• Sections:
  • H2: Install
  • H2: Quick setup
  • H2: What it is
  • H2: Inbound durability
  • H2: Token refresh (optional)
  • H2: Multi-account support
  • H2: Access control
  • H2: Troubleshooting
  • H2: Config
  • H3: Account config
  • H3: Provider options
  • H2: Tool actions
  • H2: Safety and ops
  • H2: Limits
  • H2: Related

channels/wechat.md

• Path: /channels/wechat
• Sections:
  • H2: Naming
  • H2: How it works
  • H2: Install
  • H2: Login
  • H2: Access control
  • H2: Compatibility
  • H2: Sidecar process
  • H2: Troubleshooting
  • H2: Related docs

channels/whatsapp.md

• Path: /channels/whatsapp
• Sections:
  • H2: Install
  • H2: Quick setup
  • H2: Deployment patterns
  • H2: Runtime model
  • H2: Call the current requester with MeowCaller (experimental)
  • H2: Approval prompts
  • H2: Question reactions
  • H2: Plugin hooks and privacy
  • H2: Access control and activation
  • H2: Configured ACP bindings
  • H2: Personal-number and self-chat behavior
  • H2: Message normalization and context
  • H2: Delivery, chunking, and media
  • H2: Reply quoting
  • H2: Reaction level
  • H2: Acknowledgment reactions
  • H2: Lifecycle status reactions
  • H2: Multi-account and credentials
  • H2: Tools, actions, and config writes
  • H2: Troubleshooting
  • H2: System prompts
  • H2: Configuration reference pointers
  • H2: Related

channels/yuanbao.md

• Route: /channels/yuanbao
• Headings:
  • H2: Quick start
  • H3: Interactive setup (alternative)
  • H2: Access control
  • H3: Direct messages
  • H3: Group chats
  • H2: Configuration examples
  • H2: Common commands
  • H2: Troubleshooting
  • H2: Advanced configuration
  • H3: Multiple accounts
  • H3: Message limits
  • H3: Streaming
  • H3: Group chat history context
  • H3: Reply-to mode
  • H3: Markdown hint injection
  • H3: Debug mode
  • H3: Multi-agent routing
  • H2: Configuration reference
  • H2: Supported message types
  • H2: Related

channels/zalo.md

• Route: /channels/zalo
• Headings:
  • H2: Bundled plugin
  • H2: Quick setup
  • H2: What it is
  • H2: How it works
  • H2: Limits
  • H2: Access control
  • H3: Direct messages
  • H3: Groups
  • H2: Long-polling vs webhook
  • H2: Supported message types
  • H2: Capabilities
  • H2: Delivery targets (CLI/cron)
  • H2: Troubleshooting
  • H2: Configuration reference
  • H2: Related

channels/zaloclawbot.md

• Route: /channels/zaloclawbot
• Headings:
  • H2: Compatibility
  • H2: Prerequisites
  • H2: Install with onboard (recommended)
  • H2: Manual installation
  • H3: 1. Install the plugin
  • H3: 2. Enable the plugin in config
  • H3: 3. Generate a QR code and log in
  • H3: 4. Restart the gateway
  • H2: How it works
  • H2: Under the hood
  • H2: Troubleshooting
  • H2: Related

channels/zalouser.md

• Route: /channels/zalouser
• Headings:
  • H2: Install
  • H2: Quick setup
  • H2: What it is
  • H2: Naming
  • H2: Finding IDs (directory)
  • H2: Limits
  • H2: Inbound durability
  • H2: Access control (DMs)
  • H2: Group access (optional)
  • H3: Group mention gating
  • H2: Multi-account
  • H2: Environment variables
  • H2: Typing, reactions, and delivery acknowledgements
  • H2: Troubleshooting
  • H2: Related

ci.md

• Route: /ci
• Headings:
  • H2: Pipeline overview
  • H2: Fail-fast order
  • H2: PR context and evidence
  • H2: Scope and routing
  • H2: ClawSweeper activity forwarding
  • H2: Manual dispatches
  • H2: Runners
  • H2: Runner registration budget
  • H2: Surface ratchets
  • H2: Local equivalents
  • H2: OpenClaw Performance
  • H2: Full Release Validation
  • H2: Live and E2E shards
  • H2: Package Acceptance
  • H3: Jobs
  • H3: Candidate sources
  • H3: Suite profiles
  • H3: Legacy compatibility windows
  • H3: Examples
  • H2: Install smoke
  • H2: Local Docker E2E
  • H3: Tunables
  • H3: Reusable live/E2E workflow
  • H3: Release-path chunks
  • H2: Plugin Prerelease
  • H2: QA Lab
  • H2: CodeQL
  • H3: Security categories
  • H3: Platform-specific security shards
  • H3: Critical Quality categories
  • H2: Maintenance workflows
  • H3: Docs Agent
  • H3: Test Performance Agent
  • H3: Duplicate PRs After Merge
  • H2: Local check gates and changed routing
  • H3: Config baseline count ratchet
  • H2: Testbox validation
  • H2: Related

clawhub/cli.md

• Route: /clawhub/cli
• Headings:
  • H1: ClawHub CLI
  • H2: Discover and install
  • H3: Release trust
  • H2: Publish and maintain
  • H2: Related

clawhub/publishing.md

• Route: /clawhub/publishing
• Headings:
  • H1: Publishing on ClawHub
  • H2: Owners
  • H2: Skills
  • H2: Plugins
  • H2: Release flow
  • H2: FAQ
  • H3: Package scope must match selected owner

cli/acp.md

• Route: /cli/acp
• Headings:
  • H2: What this is not
  • H2: Compatibility matrix
  • H2: Known limitations
  • H2: Usage
  • H2: ACP client (debug)
  • H2: Protocol smoke testing
  • H2: How to use this
  • H2: Selecting agents
  • H2: Use from acpx (Codex, Claude, other ACP clients)
  • H2: Zed editor setup
  • H2: Session mapping
  • H2: Options
  • H3: acp client options
  • H2: Related

cli/agent.md

• Route: /cli/agent
• Headings:
  • H1: openclaw agent
  • H2: Options
  • H2: Examples
  • H2: Notes
  • H2: JSON delivery status
  • H2: Related

cli/agents.md

• Route: /cli/agents
• Headings:
  • H1: openclaw agents
  • H2: Examples
  • H2: Command surface
  • H3: agents list
  • H3: agents add [name]
  • H3: agents bindings
  • H3: agents bind
  • H3: agents unbind
  • H3: agents set-identity
  • H3: agents delete <id>
  • H2: Routing bindings
  • H3: --bind format
  • H3: Binding scope behavior
  • H2: Identity files
  • H2: Set identity
  • H2: Related

cli/approvals.md

• Route: /cli/approvals
• Headings:
  • H1: openclaw approvals
  • H2: openclaw exec-policy
  • H2: Common commands
  • H2: Pending approvals
  • H2: Replace approvals from a file
  • H2: "Never prompt" / YOLO example
  • H2: Allowlist helpers
  • H2: Common options
  • H2: Notes
  • H2: Related

cli/attach.md

• Route: /cli/attach
• Headings: none

cli/audit.md

• Route: /cli/audit
• Headings:
  • H1: openclaw audit
  • H2: Filters
  • H2: Recorded events
  • H2: Gateway RPC
  • H2: Related

cli/backup.md

• Route: /cli/backup
• Headings:
  • H1: openclaw backup
  • H2: Notes
  • H2: SQLite snapshots
  • H3: Verify and restore
  • H2: What gets backed up
  • H2: Invalid config behavior
  • H2: Size and performance
  • H2: Related

cli/browser.md

• Route: /cli/browser
• Headings:
  • H1: openclaw browser
  • H2: Common flags
  • H2: Quick start (local)
  • H2: Quick troubleshooting
  • H2: Lifecycle
  • H2: If the command is missing
  • H2: Profiles
  • H2: Tabs
  • H2: Snapshot / screenshot / actions
  • H2: State and storage
  • H2: Debugging
  • H2: Existing Chrome via MCP
  • H2: Remote browser control (node host proxy)
  • H2: Related

cli/channels.md

• Route: /cli/channels
• Headings:
  • H1: openclaw channels
  • H2: Common commands
  • H2: Status / capabilities / resolve / logs
  • H2: Inbound dead letters
  • H2: Add / remove accounts
  • H2: Login and logout (interactive)
  • H2: Troubleshooting
  • H2: Capabilities probe
  • H2: Resolve names to IDs
  • H2: Related

cli/clawbot.md

• Route: /cli/clawbot
• Headings:
  • H1: openclaw clawbot
  • H2: Migration
  • H2: Related

cli/claws.md

• Route: /cli/claws
• Headings:
  • H1: openclaw claws
  • H2: Create a Claw package
  • H2: Inspect and preview
  • H2: Inspect installed state
  • H2: Update an installed Claw
  • H2: Remove an installed Claw
  • H2: Export an installed agent
  • H2: Command reference
  • H2: See also

cli/commitments.md

• Route: /cli/commitments
• Headings:
  • H2: Usage
  • H2: Options
  • H2: Examples
  • H2: Output
  • H2: Related

cli/completion.md

• Route: /cli/completion
• Headings:
  • H1: openclaw completion
  • H2: Usage
  • H2: Options
  • H2: Install flow
  • H2: Notes
  • H2: Related

cli/config.md

• Route: /cli/config
• Headings:
  • H2: Root options
  • H2: Examples
  • H3: Paths
  • H3: config get
  • H3: config file
  • H3: config schema
  • H3: config validate
  • H2: Values
  • H2: config set modes
  • H3: Provider builder flags
  • H2: config patch
  • H2: Dry run
  • H3: JSON output shape
  • H2: Applying changes
  • H2: Write safety
  • H2: Repair loop
  • H2: Related

cli/configure.md

• Route: /cli/configure
• Headings:
  • H1: openclaw configure
  • H2: Options
  • H2: Model section
  • H2: Web section
  • H2: Other notes
  • H2: Related

cli/crestodian.md

• Route: /cli/crestodian
• Headings: none

cli/cron.md

• Route: /cli/cron
• Headings:
  • H1: openclaw cron
  • H2: Create jobs quickly
  • H2: Sessions
  • H2: Delivery
  • H3: Delivery ownership
  • H3: Failure delivery
  • H2: Scheduling
  • H3: One-shot jobs
  • H3: Recurring jobs
  • H3: Manual runs
  • H2: Models
  • H3: Isolated cron model precedence
  • H3: Fast mode
  • H3: Live model switch retries
  • H2: Run output and denials
  • H3: Stale acknowledgement suppression
  • H3: Silent token suppression
  • H3: Structured denials
  • H2: Retention
  • H2: Migrating older jobs
  • H2: Common edits
  • H2: Common admin commands
  • H2: Related

cli/daemon.md

• Path: /cli/daemon
• Page sections:
  • H1: openclaw daemon
  • H2: Usage
  • H2: Subcommands and options
  • H2: Notes
  • H2: Related

cli/dashboard.md

• Path: /cli/dashboard
• Page sections:
  • H1: openclaw dashboard
  • H2: Machine-readable output
  • H2: Related

cli/devices.md

• Path: /cli/devices
• Page sections:
  • H1: openclaw devices
  • H2: Common options
  • H2: Commands
  • H3: openclaw devices list
  • H3: openclaw devices approve [requestId] [--latest]
  • H3: openclaw devices reject <requestId>
  • H3: openclaw devices remove <deviceId>
  • H3: openclaw devices rename --device <id> --name <label>
  • H3: openclaw devices clear --yes [--pending]
  • H3: openclaw devices rotate --device <id> --role <role> [--scope <scope...>]
  • H3: openclaw devices revoke --device <id> --role <role>
  • H2: Notes
  • H2: Token drift recovery checklist
  • H2: Paperclip / openclaw_gateway first-run approval
  • H2: Related

cli/directory.md

• Path: /cli/directory
• Page sections:
  • H1: openclaw directory
  • H2: Common flags
  • H2: Notes
  • H2: Using results with message send
  • H2: ID formats by channel
  • H2: Self ("me")
  • H2: Peers (contacts/users)
  • H2: Groups
  • H2: Related

cli/dns.md

• Path: /cli/dns
• Page sections:
  • H1: openclaw dns
  • H2: dns setup
  • H2: Related

cli/docs.md

• Path: /cli/docs
• Page sections:
  • H1: openclaw docs
  • H2: Usage
  • H2: Examples
  • H2: How it works
  • H2: Output
  • H2: Exit codes
  • H2: Related

cli/doctor.md

• Path: /cli/doctor
• Page sections:
  • H1: openclaw doctor
  • H2: Postures
  • H2: Examples
  • H2: Options
  • H2: Lint mode
  • H2: Structured health checks
  • H2: Check selection
  • H2: Post-upgrade mode
  • H2: Legacy state migration
  • H2: Shared state SQLite compaction
  • H2: Session SQLite migration
  • H3: Downgrading After Session SQLite Migration
  • H2: Notes
  • H2: macOS: launchctl env overrides
  • H2: Related

cli/fleet.md

• Path: /cli/fleet
• Page sections:
  • H1: openclaw fleet
  • H2: Quick start
  • H2: Tenant IDs
  • H2: fleet create
  • H3: Create options
  • H3: Pinning by digest
  • H3: Disk limits
  • H3: Egress policy
  • H2: fleet list
  • H2: fleet status
  • H2: fleet logs
  • H2: fleet start, fleet stop, and fleet restart
  • H2: fleet upgrade
  • H2: fleet backup and fleet restore
  • H2: fleet doctor
  • H2: fleet rm
  • H2: Storage and container layout
  • H2: Security profile
  • H2: Token handling
  • H2: Related

cli/flows.md

• Path: /cli/flows
• Page sections:
  • H1: openclaw tasks flow
  • H2: Subcommands
  • H3: Status filter values
  • H2: Examples
  • H2: Related

cli/gateway.md

• Path: /cli/gateway
• Page sections:
  • H2: Run the Gateway
  • H3: Options
  • H2: Restart the Gateway
  • H3: External supervisors
  • H3: Gateway profiling
  • H2: Query a running Gateway
  • H3: gateway health
  • H3: gateway usage-cost
  • H3: gateway stability
  • H3: gateway diagnostics export
  • H3: gateway status
  • H3: gateway probe
  • H4: Remote over SSH (Mac app parity)
  • H3: gateway call <method>
  • H2: Manage the Gateway service
  • H3: Install with a wrapper
  • H2: Discover gateways (Bonjour)
  • H3: gateway discover
  • H2: Related

cli/health.md

• Path: /cli/health
• Page sections:
  • H1: openclaw health
  • H2: Options
  • H2: Behavior
  • H2: Related

cli/hooks.md

• Path: /cli/hooks
• Page sections:
  • H1: openclaw hooks
  • H2: List hooks
  • H2: Get hook info
  • H2: Check eligibility
  • H2: Enable a hook
  • H2: Disable a hook
  • H2: Install and update hook packs
  • H2: Bundled hooks
  • H3: command-logger log file
  • H2: Notes
  • H2: Related

cli/index.md

• Path: /cli
• Page sections:
  • H2: Command pages
  • H2: Global flags
  • H2: Output modes
  • H2: Color palette
  • H2: Command tree
  • H2: Chat slash commands
  • H2: Usage tracking
  • H2: Related

cli/infer.md

• Path: /cli/infer
• Page sections:
  • H2: Turn infer into a skill
  • H2: Command tree
  • H2: Common tasks
  • H2: Behavior
  • H2: Model
  • H2: Image
  • H2: Audio
  • H2: TTS
  • H2: Video
  • H2: Web
  • H2: Embedding
  • H2: JSON output
  • H2: Common pitfalls
  • H2: Related

cli/logs.md

• Path: /cli/logs
• Page sections:
  • H1: openclaw logs
  • H2: Options
  • H2: Shared Gateway RPC options
  • H2: Examples
  • H2: Fallback and recovery behavior
  • H2: Related

cli/mcp.md

• Path: /cli/mcp
• Page sections:
  • H2: Choose the right MCP path
  • H2: OpenClaw as an MCP server
  • H3: When to use serve
  • H3: How it works
  • H3: Choose a client mode
  • H3: What serve exposes
  • H3: Usage
  • H3: Bridge tools
  • H3: Event model
  • H3: Claude channel notifications
  • H3: MCP client config
  • H3: Options
  • H3: Security and trust boundary
  • H3: Testing
  • H3: Troubleshooting
  • H2: OpenClaw as an MCP client registry
  • H3: Saved MCP server definitions
  • H3: Common server recipes
  • H3: JSON output shapes
  • H3: Stdio transport
  • H3: SSE / HTTP transport
  • H3: OAuth workflow
  • H3: Streamable HTTP transport
  • H2: Control UI
  • H2: MCP Apps
  • H2: Current limits
  • H2: Related

cli/memory.md

• Path: /cli/memory
• Page sections:
  • H1: openclaw memory
  • H2: memory status
  • H2: memory index
  • H2: memory search
  • H2: memory promote
  • H2: memory promote-explain
  • H2: memory rem-harness
  • H2: memory rem-backfill
  • H2: Dreaming
  • H2: SecretRef gateway dependency
  • H2: Related

cli/message.md

• Path: /cli/message
• Page sections:
  • H1: openclaw message
  • H2: Channel selection
  • H2: Target formats (-t, --target)
  • H2: Common flags
  • H2: SecretRef resolution
  • H2: Actions
  • H3: Core
  • H3: Send
  • H3: Poll
  • H3: Threads
  • H3: Emojis
  • H3: Stickers
  • H3: Roles, channels, voice, events (Discord)
  • H3: Moderation (Discord)
  • H3: Broadcast
  • H2: Related

cli/migrate.md

• Path: /cli/migrate
• Page sections:
  • H1: openclaw migrate
  • H2: Commands
  • H2: Safety model
  • H2: Claude provider
  • H3: What Claude imports
  • H3: Archive and manual-review state
  • H2: Codex provider
  • H3: What Codex imports
  • H3: Manual-review Codex state
  • H2: Hermes provider
  • H3: What Hermes imports
  • H3: Supported .env keys
  • H3: Archive-only state
  • H3: After applying
  • H2: Plugin contract
  • H2: Onboarding integration
  • H2: Related

cli/models.md

• Path: /cli/models
• Page sections:
  • H1: openclaw models
  • H2: Common commands
  • H3: Status
  • H3: List
  • H3: Set default / image model
  • H3: Scan
  • H2: Aliases
  • H2: Fallbacks
  • H2: Auth profiles
  • H2: Related

cli/node.md

• Path: /cli/node
• Page sections:
  • H1: openclaw node
  • H2: Why use a node host?
  • H2: Browser proxy (zero-config)
  • H2: Run (foreground)
  • H2: Gateway auth for node host
  • H2: Service (background)
  • H2: Pairing
  • H3: Identity and pairing state
  • H2: Exec approvals
  • H2: Related

cli/nodes.md

• Path: /cli/nodes
• Page sections:
  • H1: openclaw nodes
  • H2: Status
  • H2: Pairing
  • H2: Invoke
  • H2: Notify, push, location, screen
  • H2: Related

cli/onboard.md

• Path: /cli/onboard
• Page sections:
  • H1: openclaw onboard
  • H2: Examples
  • H2: Guided flow
  • H2: Reset
  • H2: Locale
  • H2: Non-interactive setup
  • H3: Gateway auth (non-interactive)
  • H3: Local gateway health
  • H3: Interactive ref mode
  • H3: Z.AI endpoint choices
  • H2: Additional non-interactive flags
  • H2: Provider prefiltering
  • H2: Web-search follow-ups
  • H2: Other behaviors
  • H2: Common follow-up commands

cli/openclaw.md

• Path: /cli/openclaw
• Section hierarchy:
  • H1: openclaw setup
  • H2: On launch
  • H2: OpenClaw display
  • H2: Usage examples
  • H2: Operations and consent
  • H3: Revision log
  • H3: Enabling masked channel mode
  • H2: Bootstrap procedure
  • H2: AI chat
  • H3: CLI harness trust model
  • H2: Agent handoff
  • H2: Message recovery mode
  • H2: See also

cli/pairing.md

• Path: /cli/pairing
• Section hierarchy:
  • H1: openclaw pairing
  • H2: Available commands
  • H2: pairing list
  • H2: pairing approve
  • H3: Owner bootstrap
  • H2: See also

cli/path.md

• Path: /cli/path
• Section hierarchy:
  • H1: openclaw path
  • H2: Purpose
  • H2: Usage patterns
  • H2: Internal mechanics
  • H2: Subcommand list
  • H2: Global flags
  • H2: oc:// syntax
  • H2: File type addressing
  • H2: Mutation guarantees
  • H2: Examples
  • H2: Recipes per file type
  • H3: Markdown
  • H3: JSONC
  • H3: JSONL
  • H3: YAML
  • H2: Subcommand reference
  • H3: resolve <oc-path>
  • H3: find <pattern>
  • H3: set <oc-path> <value>
  • H3: validate <oc-path>
  • H3: emit <file>
  • H2: Exit codes
  • H2: Output format
  • H2: Remarks
  • H2: See also

cli/plugins.md

• Path: /cli/plugins
• Section hierarchy:
  • H2: Command list
  • H2: Author
  • H3: Provider scaffold
  • H2: Install
  • H3: Marketplace shortcut
  • H2: List
  • H3: Plugin index
  • H2: Uninstall
  • H2: Update
  • H2: Inspect
  • H2: Doctor
  • H2: Registry
  • H2: Marketplace
  • H2: See also

cli/policy.md

• Path: /cli/policy
• Section hierarchy:
  • H1: openclaw policy
  • H2: Getting started
  • H3: Policy rule reference
  • H4: Scoped overlays
  • H4: Channels
  • H4: MCP servers
  • H4: Model providers
  • H4: Network
  • H4: Message routing
  • H4: Ingress and channel access
  • H4: Gateway
  • H4: Agent workspace
  • H4: Sandbox posture
  • H4: Data Handling
  • H4: Secrets
  • H4: Exec approvals
  • H4: Auth profiles
  • H4: Tool metadata
  • H4: Tool posture
  • H2: Run checks
  • H2: Configure policy
  • H2: Accept policy state
  • H2: Findings
  • H2: Repair
  • H2: Exit codes
  • H2: See also

cli/promos.md

• Path: /cli/promos
• Section hierarchy:
  • H1: openclaw promos
  • H2: Command list
  • H2: openclaw promos list
  • H2: openclaw promos claim <slug>
  • H2: Passive discovery in models list

cli/proxy.md

• Path: /cli/proxy
• Section hierarchy:
  • H1: openclaw proxy
  • H2: Validate
  • H3: Flags
  • H2: Debug proxy
  • H2: See also

cli/qr.md

• Path: /cli/qr
• Section hierarchy:
  • H1: openclaw qr
  • H2: Flags
  • H2: Setup code contents
  • H2: Gateway URL resolution
  • H2: Auth resolution (without --remote)
  • H2: Auth resolution (with --remote)
  • H2: See also

cli/reset.md

• Path: /cli/reset
• Section hierarchy:
  • H1: openclaw reset
  • H2: Flags
  • H2: Scope options
  • H2: Remarks
  • H2: See also

cli/sandbox.md

• Path: /cli/sandbox
• Section hierarchy:
  • H2: Command list
  • H3: openclaw sandbox list
  • H3: openclaw sandbox recreate
  • H3: openclaw sandbox explain
  • H2: Why recreate is necessary
  • H2: Common causes
  • H2: Registry migration
  • H2: Settings
  • H2: See also

cli/secrets.md

• Path: /cli/secrets
• Section hierarchy:
  • H1: openclaw secrets
  • H2: Reload runtime snapshot
  • H2: Audit
  • H2: Configure (interactive helper)
  • H3: Exec provider safety
  • H2: Apply a saved plan
  • H3: Why no rollback backups
  • H2: Example
  • H2: See also

cli/security.md

• Path: /cli/security
• Section hierarchy:
  • H1: openclaw security
  • H2: Audit modes
  • H2: Inspection scope
  • H2: SecretRef behavior
  • H2: Suppressions
  • H2: JSON output
  • H2: What --fix modifies
  • H2: See also

cli/sessions.md

• Path: /cli/sessions
• Section hierarchy:
  • H1: openclaw sessions
  • H2: Follow trajectory progress
  • H2: Export a trajectory bundle
  • H2: Cleanup maintenance
  • H2: Compact a session
  • H3: sessions.compact RPC
  • H2: See also

cli/setup.md

• Path: /cli/setup
• Section hierarchy:
  • H1: openclaw setup
  • H2: Flags
  • H3: Baseline mode
  • H2: Examples
  • H2: Remarks
  • H2: See also

cli/skills.md

• Path: /cli/skills
• Section hierarchy:
  • H1: openclaw skills
  • H2: Command list
  • H2: Skill Workshop
  • H2: See also

cli/status.md

• Path: /cli/status
• Section hierarchy:
  • H2: Session and model resolution
  • H2: Usage and quota
  • H2: Overview and update status
  • H2: Secrets
  • H2: Memory
  • H2: See also

cli/system.md

• Path: /cli/system
• Section hierarchy:
  • H1: openclaw system
  • H2: Common commands
  • H2: system event
  • H2: system heartbeat last|enable|disable
  • H2: system presence
  • H2: Remarks
  • H2: See also

cli/tasks.md

• Path: /cli/tasks
• Section hierarchy:
  • H2: Usage
  • H2: Root Options
  • H2: Subcommands
  • H3: list
  • H3: show
  • H3: notify
  • H3: cancel
  • H3: audit
  • H3: maintenance
  • H3: flow
  • H2: See also

cli/transcripts.md

• Path: /cli/transcripts
• Section hierarchy:
  • H1: openclaw transcripts
  • H2: Command list
  • H2: Output
  • H2: Many sessions per day
  • H2: Missing summaries
  • H2: Upgrading the legacy file store
  • H2: Configuration

cli/tui.md

• Path: /cli/tui
• Section hierarchy:
  • H1: openclaw tui
  • H2: Flags
  • H2: Remarks
  • H2: Examples
  • H2: Config repair loop
  • H2: See also

cli/uninstall.md

• Path: /cli/uninstall
• Section hierarchy:
  • H1: openclaw uninstall
  • H2: Flags
  • H2: Examples
  • H2: Remarks
  • H2: See also

cli/update.md

• Path: /cli/update
• Section hierarchy:
  • H1: openclaw update
  • H2: Usage
  • H2: Flags
  • H2: update status
  • H2: update repair
  • H2: update wizard
  • H2: Behavior
  • H3: Restart handoff
  • H3: Control-plane response shape
  • H2: Git checkout flow
  • H3: Channel selection
  • H3: Update steps
  • H3: Plugin sync details
  • H2: See also

cli/voicecall.md

• Path: /cli/voicecall
• Section hierarchy:
  • H1: openclaw voicecall
  • H2: Subcommands
  • H2: Setup and smoke
  • H3: setup
  • H3: smoke
  • H2: Call lifecycle
  • H3: call
  • H3: start
  • H3: continue
  • H3: speak
  • H3: dtmf
  • H3: end
  • H3: status
  • H2: Logs and metrics
  • H3: tail
  • H3: latency
  • H2: Exposing webhooks
  • H3: expose
  • H2: See also

cli/webhooks.md

• Path: /cli/webhooks
• Section hierarchy:
  • H1: openclaw webhooks
  • H2: Subcommands
  • H2: webhooks gmail setup
  • H3: Required
  • H3: Pub/Sub options
  • H3: OpenClaw delivery options
  • H3: gog watch serve options
  • H3: Tailscale exposure
  • H3: Output
  • H2: webhooks gmail run
  • H2: See also

cli/wiki.md

• Path: /cli/wiki
• Section hierarchy:
  • H1: openclaw wiki
  • H2: Common commands
  • H2: Agent selection
  • H2: Commands
  • H3: wiki status
  • H3: wiki doctor
  • H3: wiki init
  • H3: wiki ingest <path>
  • H3: wiki okf import <path>
  • H3: wiki compile
  • H3: wiki lint
  • H3: wiki search <query>
  • H3: wiki get <lookup>
  • H3: wiki apply
  • H3: wiki bridge import
  • H3: wiki unsafe-local import
  • H3: wiki chatgpt import
  • H3: wiki chatgpt rollback <run-id>
  • H3: wiki obsidian ...
  • H2: Practical usage guidance
  • H2: Configuration tie-ins
  • H2: See also

cli/workboard.md

• Path: /cli/workboard
• Section hierarchy:
  • H2: Usage
  • H2: list
  • H2: create
  • H2: show
  • H2: move
  • H2: dispatch
  • H2: Slash command parity
  • H2: Permissions
  • H2: Troubleshooting
  • H3: No cards appear
  • H3: Dispatch says data-only
  • H3: Dispatch starts nothing
  • H2: See also

cli/worker.md

• Route: /cli/worker
• Headings:
  • H1: openclaw worker
  • H2: Launch contract
  • H2: Runtime boundary

concepts/active-memory.md

• Route: /concepts/active-memory
• Headings:
  • H2: Remember across conversations
  • H2: Advanced Active Memory quick start
  • H2: How it works
  • H2: When it runs
  • H3: Session types
  • H2: Session toggle
  • H2: How to see it
  • H2: Query modes
  • H2: Prompt styles
  • H2: Model fallback policy
  • H3: Speed recommendations
  • H4: Cerebras setup
  • H2: Memory tools
  • H3: Built-in memory
  • H3: LanceDB memory
  • H3: Lossless Claw
  • H2: Advanced escape hatches
  • H2: Transcript persistence
  • H2: Configuration
  • H2: Recommended setup
  • H3: Cold-start grace
  • H2: Debugging
  • H2: Common issues
  • H2: Related pages

concepts/agent-loop.md

• Route: /concepts/agent-loop
• Headings:
  • H2: Entry points
  • H2: Run sequence
  • H2: Queueing and concurrency
  • H2: Session and workspace preparation
  • H2: Prompt assembly
  • H2: Hooks
  • H3: Internal hooks (Gateway hooks)
  • H3: Plugin hooks
  • H2: Streaming
  • H2: Tool execution
  • H2: Reply shaping
  • H2: Compaction and retries
  • H2: Event streams
  • H2: Chat channel handling
  • H2: Timeouts
  • H3: Stuck session diagnostics
  • H2: Where things can end early
  • H2: Related

concepts/agent-runtimes.md

• Route: /concepts/agent-runtimes
• Headings:
  • H2: Codex surfaces
  • H2: Runtime ownership
  • H2: Runtime selection
  • H2: GitHub Copilot agent runtime
  • H2: Compatibility contract
  • H2: Status labels
  • H2: Related

concepts/agent-workspace.md

• Route: /concepts/agent-workspace
• Headings:
  • H2: Default location
  • H2: Extra workspace folders
  • H2: Workspace file map
  • H2: What is NOT in the workspace
  • H2: Git backup (recommended, private)
  • H2: Do not commit secrets
  • H2: Moving the workspace to a new machine
  • H2: Advanced notes
  • H2: Related

concepts/agent.md

• Route: /concepts/agent
• Headings:
  • H2: Workspace (required)
  • H2: Bootstrap files (injected)
  • H2: Built-in tools
  • H2: Skills
  • H2: Runtime boundaries
  • H2: Sessions
  • H2: Steering while streaming
  • H2: Model refs
  • H2: Configuration (minimal)
  • H2: Related

concepts/architecture.md

• Route: /concepts/architecture
• Headings:
  • H2: Overview
  • H2: Components and flows
  • H3: Gateway (daemon)
  • H3: Clients (mac app / CLI / web admin)
  • H3: Nodes (macOS / iOS / Android / headless)
  • H3: WebChat
  • H2: Connection lifecycle (single client)
  • H2: Wire protocol (summary)
  • H2: Pairing and local trust
  • H2: Protocol typing and codegen
  • H2: Remote access
  • H2: Operations snapshot
  • H2: Invariants
  • H2: Related

concepts/channel-docking.md

• Route: /concepts/channel-docking
• Headings:
  • H2: Example
  • H2: Why use it
  • H2: Required config
  • H2: Commands
  • H2: What changes
  • H2: What does not change
  • H2: Troubleshooting

concepts/commitments.md

• Route: /concepts/commitments
• Headings:
  • H2: Existing records
  • H2: Related

concepts/compaction.md

• Route: /concepts/compaction
• Headings:
  • H2: How it works
  • H2: Auto-compaction
  • H2: Manual compaction
  • H2: Configuration
  • H3: Using a different model
  • H3: Identifier preservation
  • H3: Active transcript byte guard
  • H3: Successor transcripts
  • H3: Compaction notices
  • H3: Memory flush
  • H2: Pluggable compaction providers
  • H2: Compaction vs pruning
  • H2: Troubleshooting
  • H2: Related

concepts/context-engine.md

• Route: /concepts/context-engine
• Headings:
  • H2: Quick start
  • H2: How it works
  • H3: Subagent lifecycle (optional)
  • H3: System prompt addition
  • H2: The legacy engine
  • H2: Plugin engines
  • H3: The ContextEngine interface
  • H3: Runtime settings
  • H3: Host requirements
  • H3: Failure isolation
  • H3: ownsCompaction
  • H2: Configuration reference
  • H2: Relationship to compaction and memory
  • H2: Tips
  • H2: Related

concepts/context.md

• Route: /concepts/context
• Headings:
  • H2: Quick start (inspect context)
  • H2: Example output
  • H3: /context list
  • H3: /context detail
  • H3: /context map
  • H2: What counts toward the context window
  • H2: How OpenClaw builds the system prompt
  • H2: Injected workspace files (Project Context)
  • H2: Skills: injected vs loaded on-demand
  • H2: Tools: there are two costs
  • H2: Commands, directives, and "inline shortcuts"
  • H2: Sessions, compaction, and pruning (what persists)
  • H2: What /context actually reports
  • H2: Related

concepts/delegate-architecture.md

• Route: /concepts/delegate-architecture
• Headings:
  • H2: What is a delegate
  • H2: Why delegates
  • H2: Capability tiers
  • H3: Tier 1: Read-Only + Draft
  • H3: Tier 2: Send on Behalf
  • H3: Tier 3: Proactive
  • H2: Prerequisites: isolation and hardening
  • H3: Hard blocks (non-negotiable)
  • H3: Tool restrictions
  • H3: Sandbox isolation
  • H3: Audit trail
  • H2: Setting up a delegate
  • H3: 1. Create the delegate agent
  • H3: 2. Configure identity provider delegation
  • H4: Microsoft 365
  • H4: Google Workspace
  • H3: 3. Bind the delegate to channels
  • H3: 4. Add credentials to the delegate agent
  • H2: Example: organizational assistant
  • H2: Scaling pattern
  • H2: Related

concepts/dreaming.md

• Route: /concepts/dreaming
• Headings:
  • H2: What dreaming writes
  • H2: Phase model
  • H2: Session transcript ingestion
  • H2: Dream Diary
  • H2: Deep ranking signals
  • H3: QA shadow trial report coverage
  • H2: Scheduling
  • H2: Quick start
  • H2: Slash command
  • H2: CLI workflow
  • H2: Key defaults
  • H2: Dreams UI
  • H2: Related

concepts/experimental-features.md

• Route: /concepts/experimental-features
• Headings:
  • H2: Currently documented flags
  • H2: Control UI Labs
  • H2: Local model lean mode
  • H3: Why these tools
  • H3: When to turn it on
  • H3: When to leave it off
  • H3: Enable
  • H2: Experimental does not mean hidden
  • H2: Related

concepts/features.md

• Route: /concepts/features
• Headings:
  • H2: Highlights
  • H2: Full list
  • H2: Related

concepts/main-session.md

• Route: /concepts/main-session
• Headings:
  • H2: Home
  • H2: What flows into the main session
  • H2: Memory across resets and conversations
  • H2: A rolling session with durable history
  • H2: When you want isolation instead
  • H2: Related

concepts/managed-worktrees.md

• Route: /concepts/managed-worktrees
• Headings:
  • H2: Layout and names
  • H2: Provision ignored files
  • H2: Run repository setup
  • H2: Session worktrees
  • H2: Snapshots, cleanup, and restore
  • H2: CLI
  • H2: Gateway methods
  • H2: Workboard workspaces

concepts/mantis-slack-desktop-runbook.md

• Route: /concepts/mantis-slack-desktop-runbook
• Headings:
  • H2: Storage model
  • H2: GitHub dispatch
  • H2: Local CLI
  • H2: Hydrate modes
  • H2: Timing interpretation
  • H2: Evidence checklist
  • H2: Failure handling
  • H2: Related

concepts/mantis.md

• Route: /concepts/mantis
• Headings:
  • H2: Ownership
  • H2: CLI commands
  • H3: discord-smoke
  • H3: run
  • H3: desktop-browser-smoke
  • H3: slack-desktop-smoke
  • H3: telegram-desktop-builder
  • H2: Evidence manifest
  • H2: GitHub automation
  • H2: Machines and secrets
  • H2: Run outcomes
  • H2: Adding a scenario
  • H2: Open questions

concepts/markdown-formatting.md

• Route: /concepts/markdown-formatting
• Headings:
  • H2: Pipeline
  • H2: IR example
  • H2: Table handling
  • H2: Chunking rules
  • H2: Link policy
  • H2: Spoilers
  • H2: Adding or updating a channel formatter
  • H2: Common gotchas
  • H2: Related

concepts/memory-builtin.md

• Route: /concepts/memory-builtin
• Headings:
  • H2: What it provides
  • H2: Getting started
  • H2: Supported embedding providers
  • H2: How indexing works
  • H2: When to use
  • H2: Troubleshooting
  • H2: Configuration
  • H2: Related

concepts/memory-honcho.md

• Path: /concepts/memory-honcho
• Page sections:
  • H2: Capabilities offered
  • H2: Tools at your disposal
  • H2: Initial setup
  • H2: Settings
  • H2: Moving current memory over
  • H2: Operational mechanics
  • H2: Honcho versus default memory
  • H2: Terminal commands
  • H2: Additional resources
  • H2: See also

concepts/memory-qmd.md

• Path: /concepts/memory-qmd
• Page sections:
  • H2: Enhancements beyond the default
  • H2: First steps
  • H3: Requirements
  • H3: Activation
  • H2: Sidecar operation explained
  • H2: Search speed and compatibility
  • H2: Model configuration overrides
  • H2: Adding extra directories to index
  • H2: Indexing chat logs
  • H2: Search boundaries
  • H2: Source references
  • H2: Appropriate use cases
  • H2: Problem solving
  • H2: Settings
  • H2: Related topics

concepts/memory-search.md

• Path: /concepts/memory-search
• Page sections:
  • H2: Getting started quickly
  • H2: Supported services
  • H2: Search mechanism
  • H2: Enhancing result relevance
  • H3: Time-based weighting
  • H3: MMR (result variety)
  • H3: Activating both features
  • H2: Multi-format memory
  • H2: Searching within a session
  • H2: Troubleshooting
  • H2: Related

concepts/memory.md

• Path: /concepts/memory
• Page sections:
  • H2: Operational mechanics
  • H2: Content organization
  • H2: Importing from other coding tools
  • H2: Action-aware recollections
  • H2: Deprecated inferred commitments
  • H2: Memory utilities
  • H2: Memory lookup
  • H2: Storage backends
  • H2: Knowledge wiki layer
  • H2: Automatic memory cleanup
  • H2: Dreaming
  • H2: Grounded backfill and live promotion
  • H2: Command line interface
  • H2: Additional reading

concepts/message-lifecycle-refactor.md

• Path: /concepts/message-lifecycle-refactor
• Page sections:
  • H2: Motivation for the restructuring
  • H2: Delivered changes
  • H3: Transmission context
  • H3: Reception context
  • H3: Real-time preview
  • H3: Persistent confirmations
  • H3: Reduced public SDK surface
  • H2: Implementation deviations from the original plan
  • H2: Specific migration pitfalls (still applicable)
  • H2: Error categorization
  • H2: Unresolved issues
  • H2: Related

concepts/messages.md

• Path: /concepts/messages
• Page sections:
  • H2: Incoming duplicate removal
  • H2: Inbound rate limiting
  • H2: Sessions and hardware
  • H2: Prompt structure and conversation context
  • H2: Tool output metadata
  • H2: Queuing and subsequent actions
  • H2: Channel run ownership
  • H2: Streaming, segmenting, and grouping
  • H2: Reasoning display and token usage
  • H2: Prefixes, threading, and responses
  • H2: Quiet replies
  • H2: Related

concepts/model-failover.md

• Path: /concepts/model-failover
• Page sections:
  • H2: Execution sequence
  • H2: Selection source policy
  • H2: Authentication failure cache bypass
  • H2: Fallback notices visible to users
  • H2: Credential storage (keys and OAuth)
  • H2: Profile identifiers
  • H2: Rotation sequence
  • H3: Session persistence (cache-friendly)
  • H3: OpenAI Codex subscription with API key backup
  • H2: Cooldown periods
  • H2: Billing deactivation
  • H2: Model fallback
  • H3: Candidate chain rules
  • H3: Errors that trigger fallback
  • H3: Cooldown skip versus probe behavior
  • H2: Session overrides and live model changes
  • H2: Monitoring and error summaries
  • H2: Related configuration

concepts/model-providers.md

• Path: /concepts/model-providers
• Page sections:
  • H2: Basic guidelines
  • H2: Setting up providers through the Control UI
  • H2: Plugin-managed provider behavior
  • H2: API key cycling
  • H2: Official provider extensions
  • H3: OpenAI
  • H3: Anthropic
  • H3: OpenAI ChatGPT/Codex OAuth
  • H3: Other subscription-based hosted services
  • H3: OpenCode
  • H3: Google Gemini (API key)
  • H3: Google Vertex and Gemini CLI
  • H3: Z.AI (GLM)
  • H3: Vercel AI Gateway
  • H3: Additional bundled provider plugins
  • H4: Notable peculiarities
  • H2: Providers via models.providers (custom/base URL)
  • H3: Moonshot AI (Kimi)
  • H3: Kimi Coding
  • H3: Volcano Engine (Doubao)
  • H3: BytePlus (International)
  • H3: Synthetic
  • H3: MiniMax
  • H3: LM Studio
  • H3: Ollama
  • H3: vLLM
  • H3: SGLang
  • H3: Local proxies (LM Studio, vLLM, LiteLLM, etc.)
  • H2: CLI examples
  • H2: Related

concepts/models.md

• Path: /concepts/models
• Page sections:
  • H2: Selection priority
  • H2: Selection source and fallback strictness
  • H2: Quick model policy
  • H2: Getting started
  • H2: "Model not permitted" (and why responses stop)
  • H2: /model in chat
  • H2: Command line interface
  • H2: Model registry (models.json)
  • H2: Related

concepts/multi-agent.md

• Path: /concepts/multi-agent
• Page sections:
  • H2: Defining a single agent
  • H2: Pathways
  • H3: Single-agent operation (default)
  • H2: Agent assistant
  • H2: Quick start
  • H2: Several agents, distinct identities
  • H2: Per-agent Memory Wiki vaults
  • H2: Cross-agent QMD memory lookup
  • H2: One WhatsApp number, multiple contacts (DM splitting)
  • H2: Routing guidelines
  • H2: Several accounts or phone numbers
  • H2: Core ideas
  • H2: Platform examples
  • H2: Typical usage patterns
  • H2: Per-agent sandbox and tool setup
  • H2: Related

concepts/multi-user.md

• Path: /concepts/multi-user
• Page sections:
  • H2: Trust limits
  • H2: Ownership and availability
  • H2: Drafts
  • H2: Turn assignment
  • H2: Related

concepts/oauth.md

• Path: /concepts/oauth
• Page sections:
  • H2: Token sink purpose
  • H2: Token storage location
  • H2: Reusing Anthropic Claude CLI
  • H2: OAuth login process
  • H3: Anthropic setup-token
  • H3: OpenAI Codex (ChatGPT OAuth)
  • H2: Token refresh and expiration
  • H2: Multiple accounts (profiles) and routing
  • H3: 1) Recommended: separate agents
  • H3: 2) Advanced: multiple profiles in one agent
  • H2: Related

concepts/parallel-specialist-lanes.md

• Path: /concepts/parallel-specialist-lanes
• Page sections:
  • H2: Fundamental concepts
  • H2: Suggested deployment sequence
  • H3: Phase 1: lane contracts and background heavy tasks
  • H3: Phase 2: priority and concurrency settings
  • H3: Phase 3: coordinator or traffic controller
  • H2: Minimal lane contract template
  • H2: Related

concepts/personal-agent-benchmark-pack.md

• Path: /concepts/personal-agent-benchmark-pack
• Page sections:
  • H2: Test situations
  • H2: Privacy approach
  • H2: Expanding the pack

concepts/presence.md

• Path: /concepts/presence
• Page sections:
  • H2: Presence attributes (displayed information)
  • H2: Sources of presence data
  • H3: 1) Gateway self-registration
  • H3: 2) WebSocket connection
  • H4: Why temporary control-plane connections are invisible
  • H3: 3) system-event signals
  • H3: 4) Node connections (role: node)
  • H2: Merging and deduplication rules (importance of instanceId)
  • H2: Time-to-live and size limits
  • H2: Remote or tunnel considerations (loopback IPs)
  • H2: Consumers
  • H3: Control UI Devices page
  • H3: macOS Instances tab
  • H2: Troubleshooting advice
  • H2: Related

concepts/progress-drafts.md

• Path: /concepts/progress-drafts
• Page sections:
  • H2: Quick start
  • H2: User experience
  • H2: Selecting a mode
  • H2: Setting up labels
  • H2: Managing progress lines
  • H3: Detailed mode
  • H3: Command or execution text
  • H3: Commentary track
  • H3: Status header
  • H3: Line count restrictions
  • H3: Rich formatting (Slack)
  • H3: Hiding tool or task lines
  • H2: Channel-specific behavior
  • H2: Completion
  • H2: Troubleshooting
  • H2: Related

concepts/qa-e2e-automation.md

• Path: /concepts/qa-e2e-automation
• Page sections:
  • H2: Command interface
  • H3: Profile-based qa execution
  • H2: Operator workflow
  • H3: Observability checks
  • H3: Matrix smoke lanes
  • H3: Discord Mantis scenarios
  • H3: Mantis Slack desktop and visual-task runners
  • H3: Credential pool health verification
  • H2: Standard scenario coverage
  • H2: Discord, Slack, Telegram, and WhatsApp QA reference
  • H3: Shared CLI flags
  • H3: Telegram QA
  • H3: Discord QA
  • H3: Slack QA
  • H4: Configuring the Slack workspace
  • H3: WhatsApp QA
  • H3: Convex credential pool
  • H2: Repository-based seeds
  • H2: Provider mock lanes
  • H2: Transport adapters
  • H3: Adding a channel
  • H3: Scenario helper names
  • H2: Reporting
  • H2: Related documentation

concepts/queue-steering.md

• Path: /concepts/queue-steering
• Sections:
  • H2: Execution boundary
  • H2: Operating modes
  • H2: Burst illustration
  • H2: Range of influence
  • H2: Debounce mechanism
  • H2: See also

concepts/queue.md

• Path: /concepts/queue
• Sections:
  • H2: Rationale
  • H2: Operational details
  • H2: Preset values
  • H2: Queue types
  • H2: Queue settings
  • H2: Steering and continuous output
  • H2: Priority order
  • H2: Per-session adjustments
  • H2: Cancelling queued turns
  • H2: Scope and assurances
  • H2: Common issues
  • H2: See also

concepts/retry.md

• Path: /concepts/retry
• Sections:
  • H2: Objectives
  • H2: Preset values
  • H2: Operation
  • H3: Model backends
  • H3: Discord
  • H3: Telegram
  • H2: Setup
  • H2: Remarks
  • H2: See also

concepts/session-pruning.md

• Path: /concepts/session-pruning
• Sections:
  • H2: Importance
  • H2: Mechanism
  • H2: Cleaning old images
  • H2: Sensible presets
  • H2: Activating or deactivating
  • H2: Pruning versus compaction
  • H2: Additional resources
  • H2: See also

concepts/session-search.md

• Path: /concepts/session-search
• Sections:
  • H1: Session lookup
  • H2: Visibility and results
  • H2: Index lifespan
  • H2: Session lookup versus memory lookup

concepts/session-state.md

• Path: /concepts/session-state
• Sections:
  • H2: Signal log
  • H2: Observers
  • H2: Notices: singular, not plural
  • H2: Reconciliation
  • H2: Storage and constraints
  • H2: See also

concepts/session-tool.md

• Path: /concepts/session-tool
• Sections:
  • H2: Tools provided
  • H2: Viewing and retrieving sessions
  • H2: Adjusting session settings and groups
  • H2: Sessions versus conversations
  • H2: Sending messages across sessions
  • H2: Status and coordination helpers
  • H2: Session state modifications
  • H2: Creating sub-agents
  • H2: Visibility
  • H2: Additional resources
  • H2: See also

concepts/session.md

• Path: /concepts/session
• Sections:
  • H2: Message routing
  • H2: Direct message separation
  • H3: Dock linked channels
  • H2: Anonymous sessions
  • H2: Recall across exchanges
  • H2: Session lifecycle
  • H2: State storage location
  • H2: Session upkeep
  • H2: Examining sessions
  • H2: Additional resources
  • H2: See also

concepts/soul.md

• Path: /concepts/soul
• Sections:
  • H2: Contents of SOUL.md
  • H2: Why this approach works
  • H2: The Molty prompt
  • H2: Desired quality
  • H2: A caution
  • H2: See also

concepts/streaming.md

• Path: /concepts/streaming
• Sections:
  • H2: Managing UI startup state
  • H2: Blocked streaming for channel messages
  • H3: Media delivery using blocked streaming
  • H2: Chunking logic (minimum and maximum)
  • H2: Merging streamed blocks
  • H2: Natural typing speed between blocks
  • H2: "Stream chunks or complete output"
  • H2: Preview streaming options
  • H3: Channel mapping
  • H3: Legacy key migration
  • H2: Runtime behavior
  • H3: Telegram
  • H3: Discord
  • H3: Slack
  • H3: Mattermost
  • H3: Matrix
  • H2: Tool progress preview updates
  • H2: Progress draft rendering
  • H3: Commentary progress lane
  • H2: See also

concepts/system-prompt.md

• Path: /concepts/system-prompt
• Sections:
  • H2: Composition
  • H2: Prompt types
  • H2: Prompt snapshots
  • H2: Workspace bootstrap injection
  • H2: Time management
  • H2: Abilities
  • H2: Reference material
  • H2: See also

concepts/timezone.md

• Path: /concepts/timezone
• Sections:
  • H2: Three timezone aspects
  • H2: Configuring user timezone
  • H2: Envelope timezone values
  • H2: Override conditions
  • H2: See also

concepts/typebox.md

• Path: /concepts/typebox
• Sections:
  • H2: Conceptual overview (30 seconds)
  • H2: Schema locations
  • H2: Current workflow
  • H2: Runtime schema usage
  • H2: Sample frames
  • H2: Minimal client (Node.js)
  • H2: End-to-end example: adding a method
  • H2: Swift codegen behavior
  • H2: Versioning and compatibility
  • H2: Schema conventions and patterns
  • H2: Live schema JSON
  • H2: Schema modification effects
  • H2: See also

concepts/typing-indicators.md

• Path: /concepts/typing-indicators
• Sections:
  • H2: Preset values
  • H2: Operating modes
  • H2: Setup
  • H2: Remarks
  • H2: See also

concepts/usage-tracking.md

• Path: /concepts/usage-tracking
• Sections:
  • H2: Definition
  • H2: Display locations
  • H2: Anthropic and OpenAI cost records
  • H2: Standard usage footer mode
  • H3: Three distinct session states
  • H3: Priority order
  • H3: Resetting versus disabling
  • H3: Toggle behavior
  • H3: Configuration
  • H2: Custom /usage full footer
  • H3: Structure
  • H3: Contract Paths
  • H3: Verbs
  • H3: Piece forms
  • H3: Example
  • H2: Providers and credentials
  • H2: See also

date-time.md

• Path: /date-time
• Sections:
  • H2: Message envelopes (local by default)
  • H3: Examples
  • H2: System prompt: current date and time
  • H2: System event lines (local by default)
  • H3: Configure user timezone and format
  • H2: Automatic time format detection
  • H2: Tool payloads and connectors (raw provider time and normalized fields)
  • H2: Related documentation

debug/node-issue.md

• Path: /debug/node-issue
• Sections:
  • H1: Node and tsx "\name is not a function" crash
  • H2: Current state
  • H2: Original symptom
  • H2: Root cause
  • H2: Current reproduction check
  • H2: Workarounds (if the crash reappears)
  • H2: References
  • H2: See also

diagnostics/flags.md

• Path: /diagnostics/flags
• Sections:
  • H2: Mechanism
  • H2: Recognized flags
  • H2: Activation via configuration
  • H2: Environment override (single use)
  • H2: Profiler flags
  • H2: Timeline artifacts
  • H2: Log destination
  • H2: Log extraction
  • H2: Remarks
  • H2: See also

gateway/1password.md

• Path: /gateway/1password
• Sections:
  • H2: Prerequisites
  • H2: Resolving config secrets with op
  • H2: Service account setup for headless Gateways
  • H2: The 1password skill for agents
  • H2: Browser sign-in with 1Password for Claude
  • H2: Security considerations
  • H2: Common issues

gateway/audit.md

• Path: /gateway/audit
• Sections:
  • H1: Audit trail
  • H2: Record categories
  • H2: Message lifecycle events
  • H3: Conversation-kind classification
  • H2: Privacy approach
  • H2: Coverage and proof constraints
  • H2: Storage, retention, and migration
  • H2: Querying
  • H2: See also

gateway/authentication.md

• Path: /gateway/authentication
• Sections:
  • H2: Recommended setup: API key (any provider)
  • H2: Anthropic: Claude CLI reuse
  • H2: Manual token entry
  • H3: SecretRef-backed credentials
  • H2: Checking model authentication status
  • H2: API key rotation (gateway)
  • H2: Removing provider authentication while the gateway is running
  • H2: Controlling which credential is used
  • H3: OpenAI and legacy openai-codex ids
  • H3: During login (CLI)
  • H3: Per-session (chat command)
  • H3: Per-agent (CLI override)
  • H2: Troubleshooting
  • H3: "No credentials found"
  • H3: Token expiring or expired
  • H2: See also

gateway/background-process.md

• Path: /gateway/background-process
• Sections:
  • H2: exec tool
  • H3: Environment overrides
  • H3: Configuration (preferred over environment overrides)
  • H2: Child process bridging
  • H2: process tool
  • H2: Examples
  • H2: See also

gateway/bonjour.md

• Path: /gateway/bonjour
• Sections:
  • H2: Wide-area Bonjour (Unicast DNS-SD) over Tailscale
  • H3: Gateway configuration
  • H3: One-time DNS server setup (gateway host, macOS only)
  • H3: Tailscale DNS settings
  • H3: Gateway listener security
  • H2: What gets advertised
  • H2: Service categories
  • H2: TXT keys (non-secret hints)
  • H2: Debugging on macOS
  • H2: Debugging in Gateway logs
  • H2: Debugging on iOS node
  • H2: When to enable Bonjour
  • H2: When to disable Bonjour
  • H2: Docker pitfalls
  • H2: Troubleshooting disabled Bonjour
  • H2: Common failure scenarios
  • H2: Escaped instance names (\032)
  • H2: Enabling, disabling, and configuration
  • H2: Related documentation

gateway/bridge-protocol.md

• Path: /gateway/bridge-protocol
• Sections:
  • H2: Purpose
  • H2: Transport layer
  • H2: Handshake and pairing
  • H2: Frames
  • H2: Exec lifecycle events
  • H2: Historical tailnet usage
  • H2: Versioning
  • H2: See also

gateway/cli-backends.md

• Path: /gateway/cli-backends
• Page structure:
  • H2: Quick start
  • H2: Using it as a fallback
  • H2: Configuration
  • H2: How it works
  • H2: Timeouts and long-running work
  • H3: Claude CLI specifics
  • H3: Claude browser tools and 1Password sign-in
  • H2: Sessions
  • H2: Fallback prelude from claude-cli sessions
  • H2: Images
  • H2: Inputs and outputs
  • H2: Plugin-owned defaults
  • H2: Text transform overlays
  • H2: Native compaction ownership
  • H2: Bundle MCP overlays
  • H2: Reseed history cap
  • H2: Limitations
  • H2: Troubleshooting
  • H2: Related

gateway/clients.md

• Path: /gateway/clients
• Page structure:
  • H2: Install the packages
  • H2: Choose scopes and pair the device
  • H2: Advertise client capabilities
  • H2: Recover state after reconnect
  • H2: Use history metadata and stable anchors
  • H2: Subscribe instead of polling usage
  • H2: Backfill exec approvals
  • H2: Track protocol versions
  • H2: Related

gateway/cloud-workers.md

• Path: /gateway/cloud-workers
• Page structure:
  • H2: What runs where
  • H2: Requirements
  • H2: Configuration
  • H3: The setup command
  • H3: Install channels
  • H2: Dispatching a session
  • H2: Security model
  • H2: Troubleshooting
  • H2: Related

gateway/config-agents.md

• Path: /gateway/config-agents
• Page structure:
  • H2: Agent defaults
  • H3: agents.defaults.workspace
  • H3: agents.defaults.repoRoot
  • H3: agents.defaults.skills
  • H3: agents.defaults.skipBootstrap
  • H3: agents.defaults.skipOptionalBootstrapFiles
  • H3: agents.defaults.contextInjection
  • H3: agents.defaults.bootstrapMaxChars
  • H3: agents.defaults.bootstrapTotalMaxChars
  • H3: Per-agent bootstrap profile overrides
  • H3: agents.defaults.bootstrapPromptTruncationWarning
  • H3: Context budget ownership map
  • H4: agents.defaults.startupContext
  • H4: agents.defaults.contextLimits
  • H4: agents.entries.*.contextLimits
  • H4: skills.limits.maxSkillsPromptChars
  • H4: agents.entries.*.skillsLimits.maxSkillsPromptChars
  • H3: agents.defaults.imageMaxDimensionPx
  • H3: agents.defaults.imageQuality
  • H3: agents.defaults.userTimezone
  • H3: agents.defaults.timeFormat
  • H3: agents.defaults.model
  • H3: Runtime policy
  • H3: CLI backend selection
  • H3: agents.defaults.promptOverlays
  • H3: agents.defaults.heartbeat
  • H3: agents.defaults.compaction
  • H3: agents.defaults.contextPruning
  • H3: Block streaming
  • H3: Typing indicators
  • H3: agents.defaults.sandbox
  • H3: agents.entries (per-agent overrides)
  • H2: Multi-agent routing
  • H3: Binding match fields
  • H3: Per-agent access profiles
  • H2: Session
  • H2: Messages
  • H3: Response prefix
  • H3: Ack reaction
  • H3: Queue
  • H3: Inbound debounce
  • H3: Other message keys
  • H3: TTS (text-to-speech)
  • H2: Talk
  • H2: Related

gateway/config-channels.md

• Path: /gateway/config-channels
• Page structure:
  • H2: Channels
  • H3: DM and group access
  • H3: Channel model overrides
  • H3: Channel defaults and heartbeat
  • H3: WhatsApp
  • H3: Telegram
  • H3: Discord
  • H3: Google Chat
  • H3: Slack
  • H3: Mattermost
  • H3: Signal
  • H3: iMessage
  • H3: Matrix
  • H3: Microsoft Teams
  • H3: IRC
  • H3: Multi-account (all channels)
  • H3: Other plugin channels
  • H3: Group chat mention gating
  • H4: DM history limits
  • H4: Self-chat mode
  • H3: Commands (chat command handling)
  • H2: Related

gateway/config-tools.md

• Path: /gateway/config-tools
• Page structure:
  • H2: Tools
  • H3: Tool profiles
  • H3: Tool groups
  • H3: MCP and plugin tools inside sandbox tool policy
  • H3: tools.codeMode
  • H3: tools.allow / tools.deny
  • H3: tools.byProvider
  • H3: tools.toolsBySender
  • H3: tools.elevated
  • H3: tools.exec
  • H3: tools.loopDetection
  • H3: tools.web
  • H3: tools.media
  • H3: tools.agentToAgent
  • H3: tools.sessions
  • H3: tools.sessions_spawn
  • H3: tools.experimental
  • H3: agents.defaults.subagents
  • H2: Custom providers and base URLs
  • H3: Provider field details
  • H3: Provider examples
  • H2: Related

gateway/configuration-examples.md

• Path: /gateway/configuration-examples
• Page structure:
  • H2: Quick start
  • H3: Absolute minimum
  • H3: Recommended starter
  • H2: Expanded example (major options)
  • H3: Symlinked sibling skill repo
  • H2: Common patterns
  • H3: Shared skill baseline with one override
  • H3: Multi-platform setup
  • H3: Trusted node network auto-approval
  • H3: Secure DM mode (shared inbox / multi-user DMs)
  • H3: Anthropic API key + MiniMax fallback
  • H3: Work bot (restricted access)
  • H3: Local models only
  • H2: Tips
  • H2: Related

gateway/configuration-reference.md

• Path: /gateway/configuration-reference
• Page structure:
  • H2: Channels
  • H2: Agent defaults, multi-agent, sessions, and messages
  • H2: Tools and custom providers
  • H2: Models
  • H2: MCP
  • H2: Skills
  • H2: Plugins
  • H3: Codex harness plugin config
  • H2: Browser
  • H2: UI
  • H2: Gateway
  • H3: OpenAI-compatible endpoints
  • H3: Multi-instance isolation
  • H3: gateway.tls
  • H3: gateway.reload
  • H2: Cloud worker environments
  • H3: Crabbox profile
  • H3: Static SSH development profile
  • H2: Hooks
  • H3: Gmail integration
  • H2: Canvas plugin host
  • H2: Discovery
  • H3: mDNS (Bonjour)
  • H3: Wide-area (DNS-SD)
  • H2: Environment
  • H3: env (inline env vars)
  • H3: Env var substitution
  • H2: Secrets
  • H3: SecretRef
  • H3: Supported credential surface
  • H3: Secret providers config
  • H2: Auth storage
  • H2: Audit
  • H2: Logging
  • H2: Diagnostics
  • H2: Update
  • H2: ACP
  • H2: Wizard
  • H2: Identity
  • H2: Bridge (legacy, removed)
  • H2: Cron
  • H3: cron.failureAlert
  • H3: cron.failureDestination
  • H2: Media model template variables
  • H2: Config includes ($include)
  • H2: Related

gateway/configuration.md

• Path: /gateway/configuration
• Page structure:
  • H2: Minimal config
  • H2: Editing config
  • H2: Strict validation
  • H2: Common tasks
  • H2: Config hot reload
  • H3: Reload modes
  • H3: What hot-applies vs what needs a restart
  • H3: Reload planning
  • H2: Config RPC (programmatic updates)
  • H2: Environment variables
  • H2: Full reference
  • H2: Related

gateway/diagnostics.md

• Path: /gateway/diagnostics
• Page structure:
  • H2: Quick start
  • H2: Chat command
  • H2: What the export contains
  • H2: Privacy model
  • H2: Stability recorder
  • H2: Useful options
  • H2: Disable diagnostics
  • H2: Related

gateway/discovery.md

• Path: /gateway/discovery
• Page structure:
  • H2: Terms
  • H2: Why direct and SSH both exist
  • H2: Discovery inputs
  • H3: 1) Bonjour / DNS-SD
  • H4: Service beacon details
  • H3: 2) Tailnet (cross-network)
  • H3: 3) Manual / SSH target
  • H2: Transport selection (client policy)
  • H2: Pairing and auth (direct transport)
  • H2: Responsibilities by component
  • H2: Related

gateway/doctor.md

• Path: /gateway/doctor
• Page structure:
  • H2: Quick start
  • H3: Headless and automation modes
  • H2: Read-only lint mode
  • H2: What it does (summary)
  • H2: Dreams UI backfill and reset
  • H2: Detailed behavior and rationale
  • H2: Related

gateway/embedding.md

• Path: /gateway/embedding
• Page structure:
  • H2: Start the child with an embedding preset
  • H3: Electron shell snapshot warning
  • H2: Handle invalid config by exit code
  • H2: Wait for protocol readiness
  • H2: Interpret restart and shutdown
  • H2: Use RPC instead of state files
  • H2: Install; do not flatten
  • H2: Related

gateway/external-apps.md

• Path: /gateway/external-apps
• Page structure:
  • H2: What is available today
  • H2: Recommended path
  • H2: Cooperative host suspension
  • H2: App code vs plugin code
  • H2: Related

gateway/gateway-lock.md

• Path: /gateway/gateway-lock
• Page structure:
  • H2: Why
  • H2: Three layers
  • H3: State and config locks
  • H3: Socket bind
  • H2: Operational notes
  • H2: Related

gateway/health.md

• Path: /gateway/health
• Page structure:
  • H2: Quick checks
  • H2: Deep diagnostics
  • H2: Health monitor config
  • H2: Uptime monitoring
  • H3: Monitoring service setup examples
  • H2: When something fails
  • H2: Dedicated "health" command
  • H2: Related

gateway/heartbeat.md

• Path: /gateway/heartbeat
• Page structure:
  • H2: Quick start (beginner)
  • H2: Defaults
  • H2: What the heartbeat prompt is for
  • H2: Response contract
  • H2: Config
  • H3: Scope and precedence
  • H3: Per-agent heartbeats
  • H3: Active hours example
  • H3: 24/7 setup
  • H3: Multi-account example
  • H3: Field notes
  • H2: Delivery behavior
  • H2: Visibility controls
  • H3: What each flag does
  • H3: Per-channel vs per-account examples
  • H3: Common patterns
  • H2: Monitor scratch (optional)
  • H3: Schedule recurring checks with cron
  • H3: Can the agent update its scratch?
  • H2: Manual wake (on-demand)
  • H2: Cost awareness
  • H2: Context overflow after heartbeat
  • H2: Related

gateway/index.md

• Path: /gateway
• Sections:
  • H2: Starting locally in five minutes
  • H2: How the runtime operates
  • H2: Endpoints compatible with OpenAI
  • H3: Port and bind priority rules
  • H3: Hot reload behavior options
  • H2: Operator command reference
  • H2: Running several gateways on one machine
  • H2: Connecting from outside the network
  • H2: Managing supervision and service lifecycles
  • H2: Development profile shortcut
  • H2: Protocol quick reference for operators
  • H2: Operational health checks
  • H3: Liveness check
  • H3: Readiness check
  • H3: Gap recovery mechanism
  • H2: Common failure patterns
  • H2: Safety guarantees provided
  • H2: See also

gateway/local-model-services.md

• Path: /gateway/local-model-services
• Sections:
  • H2: Mechanism overview
  • H2: Configuration structure
  • H2: Field descriptions
  • H2: Inferrs usage example
  • H2: ds4 usage example
  • H2: See also

gateway/local-models.md

• Path: /gateway/local-models
• Sections:
  • H2: Minimum hardware requirements
  • H2: Selecting a backend
  • H2: Using LM Studio with a large local model for the Responses API
  • H3: Mixed configuration with a hosted primary and local fallback
  • H3: Regional hosting and data routing
  • H2: Other local proxies compatible with OpenAI
  • H2: Smaller or more restrictive backends
  • H2: Solving common problems
  • H2: See also

gateway/logging.md

• Path: /gateway/logging
• Sections:
  • H1: Logging
  • H2: Logging to files
  • H3: Verbose output versus log levels
  • H2: Capturing console output
  • H2: Redacting sensitive information
  • H2: Gateway WebSocket log entries
  • H3: WebSocket log format
  • H2: Formatting console output with subsystem logging
  • H2: See also

gateway/multi-tenant-hosting.md

• Path: /gateway/multi-tenant-hosting
• Sections:
  • H1: Hosting multiple tenants
  • H2: Why each tenant requires a separate cell
  • H2: System architecture
  • H2: Trust boundaries
  • H2: Isolation levels
  • H2: Getting started quickly
  • H2: Current feature scope
  • H2: See also

gateway/multiple-gateways.md

• Path: /gateway/multiple-gateways
• Sections:
  • H2: Rescue bot quick start
  • H3: Changes applied by --profile rescue onboard
  • H2: Setting up multiple gateways in general
  • H2: Isolation verification checklist
  • H2: Port mapping derived automatically
  • H2: Browser and CDP notes (common mistake)
  • H2: Manual environment variable example
  • H2: Quick verification steps
  • H2: See also

gateway/network-model.md

• Path: /gateway/network-model
• Sections:
  • H2: See also

gateway/openai-http-api.md

• Path: /gateway/openai-http-api
• Sections:
  • H2: Activating the endpoint
  • H2: Security boundaries (critical)
  • H2: Authentication methods
  • H2: When to use this endpoint
  • H2: Agent-first model contract
  • H2: Session behavior
  • H2: Request size limits
  • H2: Chat tool contract
  • H3: Supported request fields
  • H3: Variants that are not supported
  • H3: Tool response format for non-streaming
  • H3: Tool response format for streaming
  • H3: Tool follow-up loop
  • H2: Streaming with SSE
  • H2: Quick setup for Open WebUI
  • H2: Usage examples
  • H2: See also

gateway/openresponses-http-api.md

• Path: /gateway/openresponses-http-api
• Sections:
  • H2: Authentication, security, and request routing
  • H2: Session behavior
  • H2: Request structure
  • H2: Input items
  • H3: message
  • H3: function_call_output for turn-based tools
  • H3: reasoning and item_reference
  • H2: Client-side function tools
  • H2: Image handling with input_image
  • H2: File handling with input_file
  • H2: Limits for files and images
  • H2: Streaming via SSE
  • H2: Usage information
  • H2: Error handling
  • H2: Examples
  • H2: See also

gateway/openshell.md

• Path: /gateway/openshell
• Sections:
  • H2: What you need beforehand
  • H2: Starting quickly
  • H2: Workspace modes available
  • H3: mirror (default behavior)
  • H3: remote
  • H3: Deciding which mode to use
  • H2: Configuration reference
  • H2: Examples
  • H3: Minimal remote configuration
  • H3: Mirror mode with GPU access
  • H3: Per-agent OpenShell with a custom gateway
  • H2: Managing the lifecycle
  • H2: Security hardening measures
  • H2: Known limitations
  • H2: How it functions internally
  • H2: See also

gateway/opentelemetry.md

• Path: /gateway/opentelemetry
• Sections:
  • H2: Starting quickly
  • H2: Signals that are exported
  • H2: Configuration reference
  • H3: Environment variable settings
  • H2: Privacy and content capture
  • H2: Sampling and flushing behavior
  • H3: Model call observation units
  • H3: Fidelity of model calls in Claude Code CLI
  • H2: Metrics that are exported
  • H3: Model usage metrics
  • H3: Message flow metrics
  • H3: Talk metrics
  • H3: Queue and session metrics
  • H3: Session liveness telemetry
  • H3: Harness lifecycle metrics
  • H3: Tool execution and loop detection
  • H3: Exec metrics
  • H3: Diagnostics internals for memory, payloads, and exporter health
  • H2: Spans that are exported
  • H2: Diagnostic event catalog
  • H2: Operating without an exporter
  • H2: Disabling OpenTelemetry
  • H2: See also

gateway/operator-scopes.md

• Path: /gateway/operator-scopes
• Sections:
  • H2: Role definitions
  • H2: Scope hierarchy
  • H2: Method scope as only the initial check
  • H2: Approving device pairings
  • H2: Approving node pairings
  • H2: Authentication with shared secrets

gateway/pairing.md

• Path: /gateway/pairing
• Sections:
  • H2: How capability approval functions
  • H2: CLI workflow for headless environments
  • H2: API surface in the gateway protocol
  • H2: Node command gating since version 2026.3.31
  • H2: Node event trust boundaries since version 2026.3.31
  • H2: Automatic approval for SSH-verified devices (default)
  • H2: Automatic approval in the macOS app
  • H2: Automatic approval from trusted CIDR ranges
  • H2: Silent pairing supersede cleanup
  • H2: Automatic approval on metadata upgrade
  • H2: QR code pairing helpers
  • H2: Locality and forwarded header handling
  • H2: Local, private storage
  • H2: Transport behavior
  • H2: See also

gateway/prometheus.md

• Path: /gateway/prometheus
• Sections:
  • H2: Starting quickly
  • H2: Metrics that are exported
  • H2: Label policy
  • H2: PromQL recipe examples
  • H2: Deciding between Prometheus and OpenTelemetry export
  • H2: Troubleshooting
  • H2: See also

gateway/protocol.md

• Path: /gateway/protocol
• Sections:
  • H2: npm packages
  • H2: Transport layer and message framing
  • H2: Handshake procedure
  • H3: Worker role and closed protocol
  • H3: Client capabilities
  • H3: Node connection example
  • H2: Roles and scopes
  • H3: Capabilities, commands, and permissions for nodes
  • H2: Presence tracking
  • H3: Node background alive event
  • H2: Broadcast event scoping
  • H2: RPC method categories
  • H3: Common event categories
  • H3: Node helper methods
  • H2: Audit ledger RPC
  • H2: Task ledger RPCs
  • H2: Operator helper methods
  • H3: models.list views
  • H2: Exec approval process
  • H2: Agent delivery fallback
  • H2: Versioning scheme
  • H3: Client constants
  • H2: Authentication
  • H2: Device identity and pairing
  • H3: Device auth migration diagnostics
  • H2: TLS and certificate pinning
  • H2: Scope
  • H2: See also

gateway/remote-gateway-readme.md

• Path: /gateway/remote-gateway-readme
• Sections:
  • H1: Using OpenClaw.app with a Remote Gateway
  • H2: Configuration steps
  • H2: How it operates
  • H2: See also

gateway/remote.md

• Path: /gateway/remote
• Sections:
  • H2: The fundamental concept
  • H2: Topology choices
  • H2: Command flow and execution location
  • H2: SSH tunnel for CLI and tools
  • H2: Default remote settings for the CLI
  • H2: Credential priority order
  • H2: Remote access for the chat UI
  • H2: Remote mode for the macOS app
  • H2: Security rules for remote or VPN connections
  • H3: macOS persistent SSH tunnel via LaunchAgent
  • H4: Step 1: Add SSH configuration
  • H4: Step 2: Copy SSH key (one-time)
  • H4: Step 3: Set the gateway token
  • H4: Step 4: Create the LaunchAgent
  • H4: Step 5: Load the LaunchAgent
  • H4: Troubleshooting steps
  • H2: See also

gateway/restart-recovery.md

• Path: /gateway/restart-recovery
• Sections:
  • H2: What remains after a restart
  • H2: Graceful restarts perform a drain first
  • H2: How interrupted work gets detected
  • H2: Automatic resumption of work
  • H3: Subagents
  • H3: Background tasks
  • H3: Restarts requested by agents
  • H2: Safety valves and observability
  • H2: What is not resumed

gateway/sandbox-vs-tool-policy-vs-elevated.md

• Path: /gateway/sandbox-vs-tool-policy-vs-elevated
• Sections:
  • H2: Quick debugging
  • H2: Sandbox as the tool execution environment
  • H3: Bind mounts for a quick security check
  • H2: Tool policy governing which tools exist or are callable
  • H3: Tool groups as shorthand references
  • H2: Elevated mode for exec-only host execution
  • H2: Common fixes for sandbox jail issues
  • H3: "Tool X blocked by sandbox tool policy"
  • H3: "I thought this was main, why is it sandboxed?"
  • H2: See also

gateway/sandboxing.md

• Path: /gateway/sandboxing
• Section hierarchy:
  • H2: What gets sandboxed
  • H2: Modes, scope, and backend
  • H2: Docker backend
  • H3: Sandboxed browser
  • H2: SSH backend
  • H2: OpenShell backend
  • H2: Workspace access
  • H2: Multiple folders for one agent
  • H3: Other bind behavior
  • H2: Images and setup
  • H2: setupCommand (one-time container setup)
  • H2: Tool policy and escape hatches
  • H2: Multi-agent overrides
  • H2: Minimal enable example
  • H2: Related

gateway/secrets-plan-contract.md

• Path: /gateway/secrets-plan-contract
• Section hierarchy:
  • H2: Plan file requirements
  • H2: Plan file shape
  • H2: Provider upserts and deletes
  • H2: Supported target scope
  • H2: Target type behavior
  • H2: Path validation rules
  • H2: Failure behavior
  • H2: Exec provider consent behavior
  • H2: Runtime and audit scope notes
  • H2: Operator checks
  • H2: Related docs

gateway/secrets.md

• Path: /gateway/secrets
• Section hierarchy:
  • H2: Runtime model
  • H2: Egress-time injection (sentinels)
  • H2: Agent-access boundary
  • H2: Active-surface filtering
  • H2: Gateway auth surface diagnostics
  • H2: Onboarding reference preflight
  • H2: SecretRef contract
  • H2: Provider config
  • H2: File-backed API keys
  • H2: Exec integration examples
  • H2: MCP server environment variables
  • H2: Sandbox SSH auth material
  • H2: Supported credential surface
  • H2: Required behavior and precedence
  • H2: Activation triggers
  • H2: Degraded and recovered signals
  • H2: Command-path resolution
  • H2: Audit and configure workflow
  • H2: One-way safety policy
  • H2: Legacy auth compatibility notes
  • H2: Web UI note
  • H2: Related

gateway/security/audit-checks.md

• Path: /gateway/security/audit-checks
• Section hierarchy:
  • H2: Related

gateway/security/exposure-runbook.md

• Path: /gateway/security/exposure-runbook
• Section hierarchy:
  • H2: Choose the exposure pattern
  • H2: Pre-flight inventory
  • H2: Baseline checks
  • H2: Minimum safe baseline
  • H2: DM and group exposure
  • H2: Reverse proxy checks
  • H2: Tool and sandbox review
  • H2: Post-change validation
  • H2: Rollback plan
  • H2: Review checklist

gateway/security/index.md

• Path: /gateway/security
• Section hierarchy:
  • H2: Scope: personal assistant security model
  • H2: openclaw security audit
  • H3: What the audit checks (high level)
  • H3: Priority order when triaging findings
  • H2: Hardened baseline in 60 seconds
  • H3: Requester-scoped controls and prompt context
  • H2: Trust boundary matrix
  • H2: Not vulnerabilities by design
  • H2: Gateway and node trust
  • H2: Threat model
  • H2: DM access: pairing, allowlist, open, disabled
  • H3: Allowlists (two layers)
  • H3: DM session isolation (multi-user mode)
  • H2: Context visibility vs trigger authorization
  • H2: Prompt injection
  • H3: External content and untrusted-input wrapping
  • H3: Bypass flags (keep off in production)
  • H3: Reasoning and verbose output in groups
  • H2: Command authorization
  • H2: Control plane tools
  • H2: Node execution (system.run)
  • H2: Dynamic skills (watcher / remote nodes)
  • H2: Plugins
  • H2: Sandboxing
  • H3: Sub-agent delegation guardrail
  • H3: Read-only mode
  • H2: Per-agent access profiles (multi-agent)
  • H3: Full access (no sandbox)
  • H3: Read-only tools + read-only workspace
  • H3: No filesystem/shell access (provider messaging allowed)
  • H2: Browser control risks
  • H3: Browser SSRF policy (strict by default)
  • H2: Network exposure
  • H3: Bind, port, firewall
  • H3: Docker port publishing with UFW
  • H3: mDNS/Bonjour discovery
  • H3: Gateway WebSocket auth
  • H3: Tailscale Serve identity headers
  • H3: Reverse proxy configuration
  • H3: HSTS and origin notes
  • H3: Control UI over HTTP
  • H3: Insecure/dangerous flags
  • H2: Deployment and host trust
  • H2: Secrets on disk
  • H3: Credential storage map
  • H3: File permissions
  • H3: Workspace .env files
  • H3: Logs and transcripts
  • H2: Secure baseline (copy/paste)
  • H3: Separate numbers (WhatsApp, Signal, Telegram)
  • H2: Incident response
  • H3: Contain
  • H3: Rotate (assume compromise if secrets leaked)
  • H3: Audit
  • H3: Collect for a report
  • H2: Secret scanning
  • H2: Reporting security issues

gateway/security/rate-limiting.md

• Path: /gateway/security/rate-limiting
• Section hierarchy:
  • H2: Authentication attempts (pre-auth)
  • H3: Browser-origin connections
  • H3: Webhooks
  • H2: Control-plane writes (post-auth backstop)
  • H2: ACP session creation
  • H2: Restart cooldown
  • H2: Operational notes

gateway/security/secure-file-operations.md

• Path: /gateway/security/secure-file-operations
• Section hierarchy:
  • H2: Default: no Python helper
  • H2: What stays protected without Python
  • H2: What Python adds
  • H2: Plugin and core guidance

gateway/security/shrinkwrap.md

• Path: /gateway/security/shrinkwrap
• Section hierarchy:
  • H2: Why it matters
  • H2: Generating and checking
  • H2: Inspecting a published package

gateway/tailscale.md

• Path: /gateway/tailscale
• Section hierarchy:
  • H2: Modes
  • H2: Config examples
  • H3: Tailnet-only (Serve)
  • H3: Tailnet-only (bind to Tailnet IP)
  • H3: Public internet (Funnel + shared password)
  • H2: CLI examples
  • H2: Auth
  • H3: Tailscale identity headers (Serve only)
  • H2: Notes
  • H3: Tailscale prerequisites and limits
  • H2: Browser control (remote Gateway + local browser)
  • H2: Learn more
  • H2: Related

gateway/tools-invoke-http-api.md

• Path: /gateway/tools-invoke-http-api
• Section hierarchy:
  • H2: Authentication
  • H2: Security boundary (important)
  • H2: Request body
  • H2: Policy + routing behavior
  • H2: Responses
  • H2: Example
  • H2: Related

gateway/troubleshooting.md

• Path: /gateway/troubleshooting
• Section hierarchy:
  • H2: Command ladder
  • H2: After an update
  • H2: Split brain installs and newer config guard
  • H2: Protocol mismatch after rollback
  • H2: Skill symlink skipped as path escape
  • H2: Anthropic 429 extra usage required for long context
  • H2: Upstream 403 blocked responses
  • H2: Local OpenAI-compatible backend passes direct probes but agent runs fail
  • H2: No replies
  • H2: Dashboard control UI connectivity
  • H3: Auth detail codes quick map
  • H2: Gateway service not running
  • H2: macOS gateway silently stops responding, then resumes when you touch the dashboard
  • H2: macOS launchd supervisor loop with duplicate gateway/node LaunchAgents
  • H2: Gateway exits during high memory use
  • H2: Gateway rejected invalid config
  • H2: Gateway probe warnings
  • H2: Channel connected, messages not flowing
  • H2: Cron and heartbeat delivery
  • H2: Node paired, tool fails
  • H2: Browser tool fails
  • H2: If you upgraded and something suddenly broke
  • H2: Related

gateway/trusted-proxy-auth.md

• Path: /gateway/trusted-proxy-auth
• Section hierarchy:
  • H2: When to use
  • H2: When NOT to use
  • H2: How it works
  • H2: Configuration
  • H3: Configuration reference
  • H2: Automatic device approval
  • H2: Control UI pairing behavior
  • H2: Operator scopes header
  • H2: TLS termination and HSTS
  • H3: Rollout guidance
  • H2: Proxy setup examples
  • H2: Mixed token configuration
  • H2: Security checklist
  • H2: Security audit
  • H2: Troubleshooting
  • H2: Migration from token auth
  • H2: Related

help/debugging.md

• Path: /help/debugging
• Section hierarchy:
  • H2: Runtime debug overrides
  • H2: Session trace output
  • H2: Plugin lifecycle trace
  • H2: CLI startup and command profiling
  • H2: Gateway watch mode
  • H2: Dev profile + dev gateway (--dev)
  • H2: Raw stream logging
  • H2: Safety notes
  • H2: Debugging in VSCode
  • H3: Setup
  • H3: Notes
  • H2: Related

help/environment.md

• Path: /help/environment
• Section hierarchy:
  • H2: Precedence (highest to lowest)
  • H2: Supported operator-facing variables
  • H3: Paths and instances
  • H3: Gateway and authentication
  • H3: Provider credentials
  • H3: Logging and diagnostics
  • H3: Feature and runtime toggles
  • H2: Provider credentials and workspace .env
  • H2: Config env block
  • H2: Shell env import
  • H2: Exec shell snapshots
  • H2: Runtime-injected env vars
  • H2: UI env vars
  • H2: Env var substitution in config
  • H2: Secret refs vs ${ENV} strings
  • H2: Path-related env vars
  • H2: Agent helper tool downloads
  • H2: Logging
  • H3: OPENCLAW_HOME
  • H2: nvm users: webfetch TLS failures
  • H2: Legacy environment variables
  • H2: Related

help/faq-first-run.md

• Path: /help/faq-first-run
• Page sections:
  • H2: Getting started and initial configuration
  • H2: Additional resources

help/faq-models.md

• Path: /help/faq-models
• Page sections:
  • H2: Model configuration: defaults, choosing, aliases, and swapping
  • H2: When models fail and "All models failed" errors
  • H2: Authentication profiles: purpose and administration
  • H2: Additional resources

help/faq.md

• Path: /help/faq
• Page sections:
  • H2: What to check in the first minute when something breaks
  • H2: Getting started and initial configuration
  • H2: What is OpenClaw?
  • H2: Capabilities and automation
  • H2: Sandboxing and memory management
  • H2: File storage locations
  • H2: Configuration fundamentals
  • H2: Remote gateways and nodes
  • H2: Environment variables and .env file loading
  • H2: Sessions and managing multiple conversations
  • H2: Models, failover behavior, and authentication profiles
  • H2: Gateway: ports, "already running" errors, and remote operation
  • H2: Logging and debugging
  • H2: Media and file attachments
  • H2: Security and access controls
  • H2: Chat commands, stopping tasks, and "it will not stop"
  • H2: Other topics
  • H2: Additional resources

help/index.md

• Path: /help
• Page sections:
  • H2: Frequently asked questions
  • H2: Diagnostic tools
  • H2: Testing procedures
  • H2: Community and project information

help/scripts.md

• Path: /help/scripts
• Page sections:
  • H2: Naming and style rules
  • H2: Authentication monitoring scripts
  • H2: GitHub read helper
  • H2: Adding new scripts
  • H2: Additional resources

help/testing-live.md

• Path: /help/testing-live
• Page sections:
  • H2: Live tests versus your production gateway
  • H2: Local smoke commands for live testing
  • H2: Android node capability sweep
  • H2: Model smoke testing with profile keys
  • H3: Level 1: Direct model completion without a gateway
  • H3: Level 2: Gateway plus dev agent smoke (what "@openclaw" actually does)
  • H2: CLI backend smoke testing (Claude, Gemini, or other local CLIs)
  • H2: APNs HTTP/2 proxy connectivity
  • H2: ACP bind smoke test (/acp spawn ... --bind here)
  • H2: Codex app-server harness smoke test
  • H2: OpenAI repeated compaction
  • H3: Suggested live test combinations
  • H2: Model matrix coverage
  • H3: Aggregators and alternative gateways
  • H2: Credential handling (never commit)
  • H2: Deepgram live audio transcription
  • H2: BytePlus coding plan live test
  • H2: ComfyUI workflow media live test
  • H2: Image generation live test
  • H2: Music generation live test
  • H2: Video generation live test
  • H2: Media live harness
  • H2: Additional resources

help/testing-updates-plugins.md

• Path: /help/testing-updates-plugins
• Page sections:
  • H2: What we safeguard
  • H2: Local verification during development
  • H2: Docker testing pipelines
  • H2: Package acceptance checks
  • H2: Default release behavior
  • H2: Backward compatibility
  • H2: Expanding test coverage
  • H2: Handling test failures

help/testing.md

• Path: /help/testing
• Page sections:
  • H2: Quick start guide
  • H2: Temporary test directories
  • H2: Live and Docker/Parallels workflows
  • H2: QA-specific test runners
  • H3: Shared Telegram credentials through Convex (v1)
  • H3: Adding a channel to QA
  • H2: Test suites and where they execute
  • H3: Unit and integration tests (default)
  • H3: Gateway stability tests
  • H3: End-to-end repository aggregate tests
  • H3: End-to-end gateway smoke tests
  • H3: End-to-end Control UI browser mock tests
  • H3: End-to-end OpenShell backend smoke tests
  • H3: Live tests with real providers and models
  • H2: Choosing the right test suite
  • H2: Live tests that contact external services
  • H2: Docker runners for optional Linux compatibility checks
  • H2: Documentation sanity checks
  • H2: Offline regression tests safe for CI
  • H2: Agent reliability evaluations for skills
  • H2: Contract tests for plugin and channel interfaces
  • H3: Commands
  • H3: Channel contracts
  • H3: Provider contracts
  • H3: When to execute
  • H2: Guidance for adding regression tests
  • H2: Additional resources

help/troubleshooting.md

• Path: /help/troubleshooting
• Page sections:
  • H2: First 60 seconds of troubleshooting
  • H2: Assistant appears limited or missing tools
  • H2: Anthropic long context 429 errors
  • H2: Local OpenAI-compatible backend works directly but fails in OpenClaw
  • H2: Plugin installation fails due to missing openclaw extensions
  • H2: Install policy prevents plugin installation or updates
  • H2: Plugin present but blocked by suspicious ownership
  • H2: Decision tree for common issues
  • H2: Additional resources

index.md

• Path: /
• Page sections:
  • H1: OpenClaw 🦞
  • H2: Browse documentation
  • H2: What is OpenClaw?
  • H2: How it operates
  • H2: Main features
  • H2: Quick start guide
  • H2: Dashboard overview
  • H2: Optional configuration
  • H2: Start here
  • H2: Learn more

install/ansible.md

• Path: /install/ansible
• Page sections:
  • H2: Requirements
  • H2: What is provided
  • H2: Quick start
  • H2: Installed components
  • H2: Post-installation setup
  • H3: Quick command reference
  • H2: Security model
  • H2: Manual installation steps
  • H2: Updating
  • H2: Troubleshooting
  • H2: Advanced configuration options
  • H2: Additional resources

install/azure.md

• Path: /install/azure
• Page sections:
  • H2: Steps to complete
  • H2: Prerequisites
  • H2: Configure the deployment
  • H2: Deploy Azure resources
  • H2: Install OpenClaw
  • H2: Cost estimates
  • H2: Cleanup instructions
  • H2: Next steps
  • H2: Additional resources

install/bun.md

• Path: /install/bun
• Page sections:
  • H2: Installation
  • H2: Lifecycle scripts
  • H2: Known limitations
  • H2: Additional resources

install/clawdock.md

• Path: /install/clawdock
• Page sections:
  • H2: Installation
  • H2: What is included
  • H3: Basic commands
  • H3: Container access
  • H3: Web interface and pairing
  • H3: Setup and maintenance tasks
  • H3: Utility functions
  • H2: First run procedure
  • H2: Configuration and secrets management
  • H2: Additional resources

install/development-channels.md

• Path: /install/development-channels
• Page sections:
  • H2: Changing channels
  • H2: Targeting a specific version or tag
  • H2: Dry run mode
  • H2: Plugins and channels
  • H2: Viewing current status
  • H2: Tagging best practices
  • H2: macOS app availability
  • H2: Additional resources

install/digitalocean.md

• Path: /install/digitalocean
• Page sections:
  • H2: Requirements
  • H2: Configuration
  • H2: Data persistence and backups
  • H2: Tips for 1 GB RAM setups
  • H2: Troubleshooting
  • H2: Next steps
  • H2: Additional resources

install/docker-vm-runtime.md

• Path: /install/docker-vm-runtime
• Page sections:
  • H2: Embedding required binaries in the image
  • H2: Building and launching
  • H2: Persistent storage locations
  • H2: Updating
  • H2: Additional resources

install/docker.md

• Path: /install/docker
• Page sections:
  • H2: Prerequisites
  • H2: Running the gateway in a container
  • H3: Manual setup
  • H3: Upgrading container images
  • H3: Environment variables
  • H3: Source-built images with custom plugins
  • H3: Monitoring and observability
  • H3: Health check endpoints
  • H3: LAN versus loopback networking
  • H3: Host-based local providers
  • H3: Claude CLI backend inside Docker
  • H3: Bonjour and mDNS support
  • H3: Storage and data persistence
  • H3: Optional shell helper scripts
  • H3: Running on a VPS
  • H2: Agent sandbox
  • H3: Quick enable instructions
  • H2: Troubleshooting
  • H2: Additional resources

install/exe-dev.md

• Path: /install/exe-dev
• Page sections:
  • H2: Requirements
  • H2: Quick path for beginners
  • H2: Automated installation using Shelley
  • H2: Manual installation
  • H2: Setting up a remote channel
  • H2: Remote access configuration
  • H2: Updating
  • H2: Additional resources

install/fly.md

• Path: /install/fly
• Page sections:
  • H2: Requirements
  • H2: Quick path for beginners
  • H2: Troubleshooting
  • H3: "App is not listening on expected address"
  • H3: Health checks failing or connection refused
  • H3: Out of memory issues
  • H3: Gateway lock problems
  • H3: Configuration not being loaded
  • H3: Writing configuration via SSH
  • H3: State not persisting
  • H2: Updating
  • H3: Updating the machine command
  • H2: Private deployment for hardened security
  • H3: When to use private deployment
  • H3: Setup instructions
  • H3: Accessing a private deployment
  • H3: Webhooks with private deployment
  • H3: Security tradeoffs
  • H2: Notes
  • H2: Cost considerations
  • H2: Next steps
  • H2: Additional resources

install/gcp.md

• Path: /install/gcp
• Page sections:
  • H2: Required items
  • H2: Fast setup
  • H2: Issue resolution
  • H2: Security best practice with service accounts
  • H2: What to do next
  • H2: See also

install/hetzner.md

• Path: /install/hetzner
• Page sections:
  • H2: Required items
  • H2: Fast setup
  • H2: Infrastructure as Code with Terraform
  • H2: What to do next
  • H2: See also

install/hostinger.md

• Path: /install/hostinger
• Page sections:
  • H2: Before you begin
  • H2: Choice A: One-click OpenClaw deployment
  • H2: Choice B: OpenClaw on a VPS
  • H2: Confirm your configuration
  • H2: Issue resolution
  • H2: What to do next
  • H2: See also

install/index.md

• Path: /install
• Page sections:
  • H2: Hardware and software prerequisites
  • H2: Suggested approach: automated installer
  • H2: Other installation approaches
  • H3: Local prefix installer (install-cli.sh)
  • H3: npm, pnpm, or bun
  • H3: Building from source
  • H3: Install from the GitHub main branch
  • H3: Containers and package managers
  • H2: Confirm the installation
  • H2: Hosting and deployment options
  • H2: Updating, migrating, or removing
  • H2: Troubleshooting when openclaw is not found

install/installer.md

• Path: /install/installer
• Page sections:
  • H2: One-line commands
  • H2: install.sh
  • H3: Execution sequence for install.sh
  • H3: Source checkout detection
  • H3: Usage examples for install.sh
  • H2: install-cli.sh
  • H3: Execution sequence for install-cli.sh
  • H3: Usage examples for install-cli.sh
  • H2: install.ps1
  • H3: Execution sequence for install.ps1
  • H3: Usage examples for install.ps1
  • H2: Continuous integration and automation
  • H2: Issue resolution
  • H2: See also

install/kubernetes.md

• Path: /install/kubernetes
• Page sections:
  • H2: Reasons to avoid Helm
  • H2: Prerequisites
  • H2: Getting started quickly
  • H2: Local testing with Kind
  • H2: Detailed walkthrough
  • H3: Step 1: Deploy
  • H3: Step 2: Reach the gateway
  • H2: Deployed components
  • H2: Configuration options
  • H3: Agent directives
  • H3: Gateway settings
  • H3: Adding providers
  • H3: Custom namespace
  • H3: Custom container image
  • H3: Exposing beyond port forwarding
  • H2: Redeploying
  • H2: Removing the deployment
  • H2: Architectural considerations
  • H2: File layout
  • H2: See also

install/macos-vm.md

• Path: /install/macos-vm
• Page sections:
  • H2: Suggested default for most users
  • H2: macOS virtual machine choices
  • H3: Local VM on Apple Silicon Macs with Lume
  • H3: Cloud-hosted Mac providers
  • H2: Fast setup for experienced Lume users
  • H2: Prerequisites for Lume
  • H2: Step 1: Install Lume
  • H2: Step 2: Build the macOS VM
  • H2: Step 3: Finish the Setup Assistant
  • H2: Step 4: Retrieve the VM IP address
  • H2: Step 5: Connect via SSH
  • H2: Step 6: Set up OpenClaw
  • H2: Step 7: Set up channels
  • H2: Step 8: Operate the VM without a display
  • H2: Extra: iMessage integration
  • H2: Creating a reusable base image
  • H2: Continuous 24/7 operation
  • H2: Issue resolution
  • H2: Related documentation

install/migrating-claude.md

• Path: /install/migrating-claude
• Page sections:
  • H2: Two import methods
  • H2: Items transferred during import
  • H2: Items kept in archive only
  • H2: Choosing the source
  • H2: Suggested workflow
  • H2: Handling conflicts
  • H2: JSON output for automated workflows
  • H2: Issue resolution
  • H2: See also

install/migrating-hermes.md

• Path: /install/migrating-hermes
• Page sections:
  • H2: Two import methods
  • H2: Items transferred during import
  • H2: Items kept in archive only
  • H2: Suggested workflow
  • H2: Handling conflicts
  • H2: Secret management
  • H2: JSON output for automated workflows
  • H2: Issue resolution
  • H2: See also

install/migrating.md

• Path: /install/migrating
• Page sections:
  • H2: Importing from another agent platform
  • H2: Relocating OpenClaw to a different system
  • H3: Migration procedure
  • H3: Frequent mistakes
  • H3: Verification checklist
  • H2: Upgrading a plugin in place
  • H2: See also

install/nix.md

• Path: /install/nix
• Page sections:
  • H2: What is included
  • H2: Getting started quickly
  • H2: Runtime behavior under Nix mode
  • H3: Changes when using Nix mode
  • H3: Configuration and state file locations
  • H3: Service PATH discovery
  • H2: See also

install/node.md

• Path: /install/node
• Page sections:
  • H2: Verify your Node version
  • H2: Installing Node
  • H2: Issue resolution
  • H3: openclaw command not found
  • H3: Permission problems with npm install -g on Linux
  • H2: See also

install/northflank.mdx

• Path: /install/northflank
• Page sections:
  • H2: Getting started
  • H2: What is included
  • H2: Linking a channel
  • H2: What to do next

install/oracle.md

• Path: /install/oracle
• Page sections:
  • H2: Before you begin
  • H2: Configuration
  • H2: Check security posture
  • H2: ARM architecture notes
  • H2: Data persistence and backups
  • H2: Alternative: SSH tunnel
  • H2: Issue resolution
  • H2: What to do next
  • H2: See also

install/podman.md

• Path: /install/podman
• Page sections:
  • H2: Before you begin
  • H2: Getting started quickly
  • H2: Podman with Tailscale
  • H2: Systemd integration with Quadlet (optional)
  • H2: Configuration, environment, and storage
  • H2: Updating container images
  • H2: Helpful commands
  • H2: Issue resolution
  • H2: See also

install/railway.mdx

• Path: /install/railway
• Page sections:
  • H2: Deploy with one click
  • H2: What is included
  • H2: Linking a channel
  • H2: Backups and migration
  • H2: What to do next

install/raspberry-pi.md

• Path: /install/raspberry-pi
• Page sections:
  • H2: Hardware compatibility
  • H2: Before you begin
  • H2: Configuration
  • H2: Performance optimization
  • H2: Recommended model setup
  • H2: ARM binary details
  • H2: Data persistence and backups
  • H2: Issue resolution
  • H2: What to do next
  • H2: See also

install/render.mdx

• Path: /install/render
• Page sections:
  • H2: Before you begin
  • H2: Deploying
  • H2: The Blueprint
  • H2: Selecting a plan
  • H2: Post-deployment tasks
  • H3: Opening the Control UI
  • H3: Viewing logs
  • H3: Shell access
  • H3: Environment variables
  • H3: Automatic redeployment
  • H2: Custom domain setup
  • H2: Scaling
  • H2: Backups and migration
  • H2: Issue resolution
  • H3: Service fails to start
  • H3: Slow cold starts on the free tier
  • H3: Data loss after redeployment
  • H3: Health check failures
  • H2: What to do next

install/uninstall.md

• Path: /install/uninstall
• Page sections:
  • H2: Simple method when CLI is available
  • H2: Manual service removal without CLI
  • H3: macOS with launchd
  • H3: Linux with systemd user unit
  • H3: Windows with Scheduled Task
  • H2: Standard install versus source checkout
  • H3: Standard install via install.sh, npm, pnpm, or bun
  • H3: Source checkout via git clone
  • H2: See also

install/updating.md

• Path: /install/updating
• Page sections:
  • H2: Preferred method: openclaw update
  • H2: Switching between npm and git installations
  • H2: Source checkout servers with reference script
  • H2: Alternative: running the installer again
  • H2: Alternative: manual update with npm, pnpm, or bun
  • H3: Advanced npm installation topics
  • H2: Automatic updates
  • H2: Post-update steps
  • H3: Run the doctor command
  • H3: Restart the gateway
  • H3: Confirm the update
  • H2: Rolling back
  • H3: Create a verified backup before updating
  • H3: Roll back a package-based install
  • H3: Roll back a source checkout
  • H3: Downgrading across session SQLite migrations
  • H3: Restore state only when needed
  • H3: Confirm the rollback
  • H2: If you get stuck
  • H2: See also

install/upstash.md

• Path: /install/upstash
• Page sections:
  • H2: Before you begin
  • H2: Creating a Box
  • H2: Connecting via SSH tunnel
  • H2: Installing OpenClaw
  • H2: Running the onboarding process
  • H2: Starting the Gateway
  • H2: Automatic restart configuration
  • H2: Issue resolution
  • H2: See also

logging.md

• Path: /logging
• Page sections:
  • H2: Log storage locations
  • H2: Reading log output
  • H3: CLI live tail (recommended)
  • H3: Control UI web interface
  • H3: Channel-specific logs
  • H2: Log output formats
  • H3: File logs in JSONL format
  • H3: Console output
  • H3: Gateway WebSocket logs
  • H2: Logging configuration
  • H3: Severity levels
  • H3: Targeted model transport diagnostics
  • H3: Trace correlation
  • H3: Model call size and timing
  • H3: Console styling
  • H3: Data redaction
  • H2: Diagnostics and OpenTelemetry
  • H2: Troubleshooting advice
  • H2: See also

maturity/scorecard.md

• Route: /maturity/scorecard
• Headings:
  • H1: Maturity scorecard
  • H2: What this page is for
  • H2: At a glance
  • H2: Score bands
  • H2: Surface explorer
  • H2: QA evidence summary
  • H3: Readiness by area

maturity/taxonomy.md

• Route: /maturity/taxonomy
• Headings:
  • H1: Maturity taxonomy
  • H2: How to read this page
  • H2: Maturity levels
  • H2: Product areas
  • H2: Details
  • H3: Core
  • H3: Platform
  • H3: Channel
  • H3: Provider and tool

network.md

• Route: /network
• Headings:
  • H2: Core model
  • H2: Pairing + identity
  • H2: Discovery + transports
  • H2: Nodes + transports
  • H2: Security
  • H2: Related

nodes/audio.md

• Route: /nodes/audio
• Headings:
  • H2: What it does
  • H2: Auto-detection (default)
  • H2: Config examples
  • H3: Provider + CLI fallback (OpenAI + Whisper CLI)
  • H3: Provider-only (Deepgram)
  • H3: Provider-only (Mistral Voxtral)
  • H3: Provider-only (SenseAudio)
  • H3: Echo transcript to chat (opt-in)
  • H2: Notes and limits
  • H3: Resident local STT
  • H3: Proxy environment support
  • H2: Mention detection in groups
  • H2: Gotchas
  • H2: Related

nodes/camera.md

• Route: /nodes/camera
• Headings:
  • H2: iOS node
  • H3: iOS user setting
  • H3: iOS commands (via Gateway node.invoke)
  • H3: iOS foreground requirement
  • H3: CLI helper
  • H2: Android node
  • H3: Android user setting
  • H3: Permissions
  • H3: Android foreground requirement
  • H3: Android commands (via Gateway node.invoke)
  • H2: macOS app
  • H3: macOS user setting
  • H3: CLI helper (node invoke)
  • H2: Linux node host
  • H2: Safety + practical limits
  • H2: macOS screen video (OS-level)
  • H2: Related

nodes/computer-use.md

• Route: /nodes/computer-use
• Headings:
  • H2: Requirements
  • H2: The computer agent tool
  • H2: Windows and Linux (experimental, via cua-driver)
  • H3: Troubleshooting
  • H2: The computer.act node command
  • H2: Enable and arm
  • H2: Safety
  • H2: Relationship to other desktop-control paths

nodes/images.md

• Route: /nodes/images
• Headings:
  • H2: Goals
  • H2: CLI Surface
  • H2: WhatsApp Web channel behavior
  • H2: Auto-Reply Pipeline
  • H2: Inbound Media To Commands
  • H2: Limits and errors
  • H2: Notes for Tests
  • H2: Related

nodes/index.md

• Route: /nodes
• Headings:
  • H2: Pairing + status
  • H2: Version skew and upgrade order
  • H2: Remote node host (system.run)
  • H3: Start a node host (foreground)
  • H3: Remote gateway via SSH tunnel (loopback bind)
  • H3: Start a node host (service)
  • H3: Pair + name
  • H3: Node-hosted MCP servers
  • H3: Node-hosted skills
  • H3: Headless identity state
  • H3: Allowlist the commands
  • H3: Point exec at the node
  • H3: Local model inference
  • H3: Codex sessions and transcripts
  • H3: Claude sessions and transcripts
  • H3: OpenCode and Pi sessions
  • H3: Terminal file uploads
  • H2: Invoking commands
  • H2: Command policy
  • H2: Config (openclaw.json)
  • H2: Screenshots (canvas snapshots)
  • H3: Canvas controls
  • H3: A2UI (Canvas)
  • H2: Photos + videos (node camera)
  • H2: Screen recordings (nodes)
  • H2: Location (nodes)
  • H2: SMS (Android nodes)
  • H2: Device and personal data commands
  • H2: System commands (node host / mac node)
  • H2: Exec node binding
  • H2: Permissions map
  • H2: Headless node host (cross-platform)
  • H2: Mac node mode

nodes/location-command.md

• Route: /nodes/location-command
• Headings:
  • H2: TL;DR
  • H2: Why a selector (not just a switch)
  • H2: Settings model
  • H2: Permissions mapping (node.permissions)
  • H2: Command: location.get
  • H2: Background behavior
  • H2: Linux node host
  • H2: Model/tooling integration
  • H2: UX copy (suggested)
  • H2: Related

nodes/media-understanding.md

• Route: /nodes/media-understanding
• Headings:
  • H2: How it works
  • H2: Config
  • H3: Model entries
  • H3: Provider credentials
  • H2: Rules and behavior
  • H3: Auto-detect (default)
  • H3: Proxy support (audio/video provider calls)
  • H2: Capabilities
  • H2: Provider support matrix
  • H2: Model selection guidance
  • H2: Attachment policy
  • H3: File-attachment extraction
  • H2: Config examples
  • H2: Status output
  • H2: Notes
  • H2: Related

nodes/presence.md

• Route: /nodes/presence
• Headings:
  • H2: Requirements
  • H2: Check the active computer
  • H2: How activity becomes presence
  • H2: Privacy and model context
  • H2: How connection alerts are routed
  • H2: Troubleshooting
  • H2: Related

nodes/talk.md

• Route: /nodes/talk
• Headings:
  • H2: Behavior (macOS)
  • H2: Voice directives in replies
  • H2: Config (~/.openclaw/openclaw.json)
  • H2: macOS UI
  • H2: Android UI
  • H2: Notes
  • H2: Related

nodes/troubleshooting.md

• Route: /nodes/troubleshooting
• Headings:
  • H2: Command ladder
  • H2: Foreground requirements
  • H2: Permissions matrix
  • H2: Pairing versus approvals
  • H2: Common node error codes
  • H2: Fast recovery loop
  • H2: Related

nodes/voicewake.md

• Route: /nodes/voicewake
• Headings:
  • H2: Storage
  • H2: Protocol
  • H3: Trigger list
  • H3: Routing (trigger to target)
  • H3: Events
  • H2: Client behavior
  • H2: Related

openclaw-agent-runtime.md

• Route: /openclaw-agent-runtime
• Headings:
  • H2: Type checking and linting
  • H2: Running Agent Runtime Tests
  • H2: Manual testing
  • H2: Clean slate reset
  • H2: References
  • H2: Related

perplexity.md

• Route: /perplexity
• Headings:
  • H2: Related

plan/cloud-workers.md

• Route: /plan/cloud-workers
• Headings:
  • H2: Status
  • H2: Problem
  • H2: Goals
  • H2: Non-goals (v1)
  • H2: Prior art (what we copy, what we invert)
  • H2: Architecture decision: loop on the worker, inference through the gateway
  • H2: Components
  • H3: 1. Environment state machine + provider contract
  • H3: 2. Worker bootstrap: install OpenClaw on the box
  • H3: 3. Transport: everything over SSH
  • H3: 4. Worker protocol (dedicated; not the node protocol)
  • H3: 5. Session backend RPCs
  • H3: 6. Workspace sync
  • H3: 7. Placement state machine, sessions, and UI
  • H2: Dispatch and handoff
  • H2: Security model
  • H2: Capacity
  • H2: Lifecycle
  • H2: Configuration surface
  • H2: Milestones
  • H2: Open questions

plan/path3-sqlite-session-artifact-family.md

• Route: /plan/path3-sqlite-session-artifact-family
• Headings:
  • H1: Path 3 SQLite Session Artifact Family
  • H2: Authoritative family
  • H2: Non-family artifacts after the flip
  • H2: Patch points
  • H2: Focused tests

plan/swarms.md

• Route: /plan/swarms
• Headings:
  • H1: Swarms, agent fan-out and orchestration in code mode
  • H2: 1. What and why
  • H2: 2. Decisions (maintainer, 2026-07-17)
  • H2: 3. Architecture overview
  • H2: 4. Config gate (v1)
  • H2: 5. Core: collector-mode spawn + agents_wait (v1)
  • H3: 5.1 sessions_spawn additions (all gated on swarm enabled)
  • H3: 5.2 Approvals fail-closed
  • H3: 5.3 agents_wait tool (new, gated)
  • H3: 5.4 Caps enforcement
  • H2: 6. Testing contract (v1, lane A)
  • H2: 7. QuickJS guest surface (lane B, after core)
  • H2: 8. Codex harness projection (later lane)
  • H2: 9. Persistence and retention
  • H2: 10. Progress surface ("the dots"), later lane
  • H2: 11. Labs page (Control UI, independent lane)
  • H2: 12. Placement (later)
  • H2: 13. Non-goals
  • H2: 14. Build phases / PR slicing

plan/ui-channels.md

• Route: /plan/ui-channels
• Headings:
  • H2: Status
  • H2: Problem
  • H2: Goals
  • H2: Non goals
  • H2: Target model
  • H2: Delivery metadata
  • H2: Runtime capability contract
  • H2: Channel mapping
  • H2: Refactor steps
  • H2: Tests
  • H2: Open questions
  • H2: Related

platforms/android.md

• Path: /platforms/android
• Section structure:
  • H2: Support snapshot
  • H2: Simultaneous gateway sessions
  • H2: Wear OS companion
  • H2: Install outside Google Play
  • H2: Mirror and control Android from a remote Mac
  • H3: Before you begin
  • H3: Enable ADB over TCP
  • H3: Allow only the controller Mac
  • H3: Connect and start mirroring
  • H3: Troubleshooting
  • H2: Connection runbook
  • H3: Prerequisites
  • H3: 1. Start the Gateway
  • H3: 2. Verify discovery (optional)
  • H4: Cross-network discovery via unicast DNS-SD
  • H3: 3. Connect from Android
  • H3: Manage paired gateways
  • H3: Presence alive beacons
  • H3: 4. Approve pairing (CLI)
  • H3: 5. Verify the node is connected
  • H3: 6. Chat + history
  • H3: 7. Canvas + camera
  • H4: Gateway Canvas Host (recommended for web content)
  • H3: 8. Voice + expanded Android command surface
  • H3: 9. Workspace files (read-only)
  • H2: Review command approvals
  • H2: Answer agent questions
  • H2: Assistant entrypoints
  • H2: Notification forwarding
  • H2: Related

platforms/digitalocean.md

• Path: /platforms/digitalocean
• Section structure:
  • H2: Related

platforms/easyrunner.md

• Path: /platforms/easyrunner
• Section structure:
  • H2: Before you begin
  • H2: Compose app
  • H2: Configure OpenClaw
  • H2: Verify
  • H2: Updates and backups
  • H2: Troubleshooting

platforms/index.md

• Path: /platforms
• Section structure:
  • H2: Choose your OS
  • H2: VPS and hosting
  • H2: Common links
  • H2: Gateway service install (CLI)
  • H2: Related

platforms/ios-healthkit.md

• Path: /platforms/ios-healthkit
• Section structure:
  • H1: HealthKit summaries
  • H2: Requirements
  • H2: Enable access
  • H3: 1. Authorize the Gateway command
  • H3: 2. Enable sharing on the iOS device
  • H2: Request today's summary
  • H2: Privacy behavior
  • H2: Troubleshooting
  • H3: Command is not declared by the node
  • H3: Command requires explicit opt-in
  • H3: HEALTH_ACCESS_DISABLED
  • H3: Summary succeeds but metrics are missing
  • H3: Older ranges fail
  • H2: Related

platforms/ios.md

• Path: /platforms/ios
• Section structure:
  • H2: What it does
  • H2: Requirements
  • H2: Quick start (pair + connect)
  • H2: Health summaries
  • H2: Review command approvals
  • H2: Answer agent questions
  • H2: Optional direct Apple Watch node
  • H2: Relay-backed push for official builds
  • H2: Background alive beacons
  • H2: Authentication and trust flow
  • H2: Discovery paths
  • H3: Bonjour (LAN)
  • H3: Tailnet (cross-network)
  • H3: Manual host/port
  • H2: Multiple gateways
  • H2: Canvas + A2UI
  • H2: Computer Use relationship
  • H3: Canvas eval / snapshot
  • H2: Voice wake + talk mode
  • H2: Common errors
  • H2: Related docs

platforms/linux.md

• Path: /platforms/linux
• Section structure:
  • H2: Desktop companion
  • H3: Quick Chat
  • H3: Canvas
  • H2: CLI and SSH alternative
  • H2: Node capabilities
  • H2: Install
  • H2: Gateway service (systemd)
  • H2: Memory pressure and OOM kills
  • H2: Related

platforms/mac/bundled-gateway.md

• Path: /platforms/mac/bundled-gateway
• Section structure:
  • H2: Automatic setup
  • H2: Manual recovery
  • H2: Launchd (Gateway as LaunchAgent)
  • H2: Version compatibility
  • H2: State directory on macOS
  • H2: Debug app connectivity
  • H2: Smoke check
  • H2: Related

platforms/mac/canvas.md

• Path: /platforms/mac/canvas
• Section structure:
  • H2: Where Canvas lives
  • H2: Panel behavior
  • H2: Agent API surface
  • H2: A2UI in Canvas
  • H3: A2UI commands (v0.8)
  • H2: Triggering agent runs from Canvas
  • H2: Security notes
  • H2: Related

platforms/mac/child-process.md

• Path: /platforms/mac/child-process
• Section structure:
  • H2: Default behavior (launchd)
  • H2: Unsigned dev builds
  • H2: Attach-only mode
  • H2: Remote mode
  • H2: Why we prefer launchd
  • H2: Related

platforms/mac/dev-setup.md

• Path: /platforms/mac/dev-setup
• Section structure:
  • H1: macOS developer setup
  • H2: Prerequisites
  • H2: 1. Install dependencies
  • H2: 2. Build and package the app
  • H2: 3. Install the CLI and Gateway
  • H2: Troubleshooting
  • H3: Build fails: toolchain or SDK mismatch
  • H3: App crashes on permission grant
  • H3: Gateway "Starting..." indefinitely
  • H2: Related

platforms/mac/health.md

• Path: /platforms/mac/health
• Section structure:
  • H1: Health checks on macOS
  • H2: Menu bar
  • H2: Settings
  • H2: How the probe works
  • H2: When in doubt
  • H2: Related

platforms/mac/icon.md

• Path: /platforms/mac/icon
• Section structure:
  • H1: Menu Bar Icon States
  • H2: States
  • H2: Voice wake ears
  • H2: Shapes and sizes
  • H2: Behavioral notes
  • H2: Related

platforms/mac/logging.md

• Path: /platforms/mac/logging
• Section structure:
  • H1: Logging (macOS)
  • H2: Rolling diagnostics file log (Debug pane)
  • H2: Unified logging private data on macOS
  • H2: Enable for OpenClaw (ai.openclaw)
  • H2: Disable after debugging
  • H2: Related

platforms/mac/menu-bar.md

• Path: /platforms/mac/menu-bar
• Section structure:
  • H2: What is shown
  • H2: State model
  • H2: IconState enum (Swift)
  • H3: ActivityKind -> badge symbol
  • H3: Visual mapping
  • H2: Context submenu
  • H2: Status row text (menu)
  • H2: Event ingestion
  • H2: Debug override
  • H2: Testing checklist
  • H2: Related

platforms/mac/peekaboo.md

• Path: /platforms/mac/peekaboo
• Section structure:
  • H2: What this is (and is not)
  • H2: Relationship to other desktop-control paths
  • H2: Enable the bridge
  • H2: Client discovery order
  • H2: Security and permissions
  • H2: Snapshot behavior (automation)
  • H2: Troubleshooting
  • H2: Related

platforms/mac/permissions.md

• Path: /platforms/mac/permissions
• Section structure:
  • H2: Requirements for stable permissions
  • H2: Accessibility grants for Node and CLI runtimes
  • H2: Recovery checklist when prompts disappear
  • H2: Files and folders permissions (Desktop/Documents/Downloads)
  • H2: Related

platforms/mac/remote.md

• Path: /platforms/mac/remote
• Section structure:
  • H2: Modes
  • H2: Remote transports
  • H2: Prereqs on the remote host
  • H2: macOS app setup
  • H2: Web Chat
  • H2: Permissions
  • H2: Security notes
  • H2: WhatsApp login flow (remote)
  • H2: Troubleshooting
  • H2: Notification sounds
  • H2: Related

platforms/mac/signing.md

• Path: /platforms/mac/signing
• Section structure:
  • H1: mac signing (debug builds)
  • H2: Usage
  • H3: Ad-hoc signing note
  • H2: Build metadata for About
  • H2: Related

platforms/mac/skills.md

• Path: /platforms/mac/skills
• Section structure:
  • H2: Data source
  • H2: Install actions
  • H2: Env/API keys
  • H2: Remote mode
  • H2: Related

platforms/mac/voice-overlay.md

• Path: /platforms/mac/voice-overlay
• Section structure:
  • H1: Voice Overlay Lifecycle (macOS)
  • H2: Behavior
  • H2: Implementation
  • H2: Logging
  • H2: Debugging checklist
  • H2: Related

platforms/mac/voicewake.md

• Path: /platforms/mac/voicewake
• Section structure:
  • H1: Voice Wake & Push-to-Talk
  • H2: Requirements
  • H2: Modes
  • H2: Runtime behavior (wake-word)
  • H2: Lifecycle invariants
  • H2: Push-to-talk specifics
  • H2: User-facing settings
  • H2: Forwarding behavior
  • H2: Forwarding payload
  • H2: Quick verification
  • H2: Related

platforms/mac/webchat.md

• Path: /platforms/mac/webchat
• Section structure:
  • H2: Multiple Gateway windows
  • H2: Quick Chat bar
  • H2: Launch and debugging
  • H2: How it is wired
  • H2: Security surface
  • H2: Known limitations
  • H2: Related

platforms/mac/xpc.md

• Path: /platforms/mac/xpc
• Section structure:
  • H1: OpenClaw macOS IPC architecture
  • H2: Goals
  • H2: How it works
  • H3: Gateway + node transport
  • H3: Node service + app IPC
  • H3: PeekabooBridge (UI automation)
  • H2: Operational flows
  • H2: Hardening notes
  • H2: Related

platforms/macos.md

• Path: /platforms/macos
• Section structure:
  • H2: Download
  • H2: First run
  • H2: Updates
  • H2: Open dashboard links
  • H2: Import browser logins
  • H2: Choose a Gateway mode
  • H2: What the app owns
  • H2: macOS detail pages
  • H2: Related

platforms/oracle.md

• Route: /platforms/oracle
• Headings:
  • H2: Related

platforms/raspberry-pi.md

• Route: /platforms/raspberry-pi
• Headings:
  • H2: Related

platforms/windows.md

• Route: /platforms/windows
• Headings:
  • H2: Recommended: Windows Hub
  • H3: What Windows Hub includes
  • H3: First launch
  • H2: Windows node mode
  • H2: Local MCP mode
  • H2: Native Windows CLI and Gateway
  • H2: WSL2 Gateway
  • H2: Gateway auto-start before Windows login
  • H2: Expose WSL services over LAN
  • H2: Troubleshooting
  • H3: The tray icon does not appear
  • H3: Local setup fails
  • H3: The app says pairing is required
  • H3: Web chat cannot reach a remote Gateway
  • H3: screen.snapshot, camera, or audio commands fail
  • H3: Git or GitHub connectivity fails
  • H2: Related

plugins/adding-capabilities.md

• Route: /plugins/adding-capabilities
• Headings:
  • H2: When to create a capability
  • H2: The standard sequence
  • H2: What goes where
  • H2: Provider and harness seams
  • H2: File checklist
  • H2: Worked example: image generation
  • H2: Embedding providers
  • H2: Review checklist
  • H2: Related

plugins/admin-http-rpc.md

• Route: /plugins/admin-http-rpc
• Headings:
  • H2: Before you enable it
  • H2: Enable
  • H2: Verify the route
  • H2: Authentication
  • H2: Security model
  • H2: Request
  • H2: Response
  • H2: Allowed methods
  • H2: WebSocket comparison
  • H2: Troubleshooting
  • H2: Related

plugins/agent-tools.md

• Route: /plugins/agent-tools
• Headings:
  • H2: Related

plugins/architecture-internals.md

• Route: /plugins/architecture-internals
• Headings:
  • H2: Load pipeline
  • H3: Manifest-first behavior
  • H3: Plugin cache boundary
  • H2: Registry model
  • H2: Conversation binding callbacks
  • H2: Provider runtime hooks
  • H3: Hook order and usage
  • H3: Provider example
  • H3: Built-in examples
  • H2: Runtime helpers
  • H3: api.runtime.imageGeneration
  • H2: Gateway HTTP routes
  • H2: Plugin SDK import paths
  • H2: Message tool schemas
  • H2: Channel target resolution
  • H2: Config-backed directories
  • H2: Provider catalogs
  • H2: Read-only channel inspection
  • H2: Package packs
  • H3: Channel catalog metadata
  • H2: Context engine plugins
  • H2: Adding a new capability
  • H3: Capability checklist
  • H3: Capability template
  • H2: Related

plugins/architecture.md

• Route: /plugins/architecture
• Headings:
  • H2: Public capability model
  • H3: External compatibility stance
  • H3: Plugin shapes
  • H3: Compatibility signals
  • H2: Architecture overview
  • H3: Plugin metadata snapshot and lookup table
  • H3: Activation planning
  • H3: Channel plugins and the shared message tool
  • H2: Capability ownership model
  • H3: Capability layering
  • H3: Multi-capability company plugin example
  • H3: Capability example: video understanding
  • H2: Contracts and enforcement
  • H3: What belongs in a contract
  • H2: Execution model
  • H2: Export boundary
  • H2: Internals and reference
  • H2: Related

plugins/building-extensions.md

• Route: /plugins/building-extensions
• Headings:
  • H2: Related

plugins/building-plugins.md

• Route: /plugins/building-plugins
• Headings:
  • H2: Requirements
  • H2: Choose the plugin shape
  • H2: Quickstart
  • H2: Registering tools
  • H2: Import conventions
  • H2: Pre-submission checklist
  • H2: Test against beta releases
  • H2: Next steps
  • H2: Related

plugins/bundles.md

• Route: /plugins/bundles
• Headings:
  • H2: Why bundles exist
  • H2: Install a bundle
  • H2: What OpenClaw maps from bundles
  • H3: Supported now
  • H4: Skill content
  • H4: Hook packs
  • H4: MCP for embedded OpenClaw
  • H4: Embedded OpenClaw settings
  • H4: Embedded OpenClaw LSP
  • H3: Detected but not executed
  • H2: Bundle formats
  • H2: Detection precedence
  • H2: Runtime dependencies and cleanup
  • H2: Security
  • H2: Troubleshooting
  • H2: Related

plugins/cli-backend-plugins.md

• Route: /plugins/cli-backend-plugins
• Headings:
  • H2: What the plugin owns
  • H2: Minimal backend plugin
  • H2: Config shape
  • H2: Advanced backend hooks
  • H3: ownsNativeCompaction: opting out of OpenClaw compaction
  • H2: MCP tool bridge
  • H2: Selecting the backend
  • H2: Verification
  • H2: Checklist
  • H2: Related

plugins/codex-computer-use.md

• Route: /plugins/codex-computer-use
• Headings:
  • H2: OpenClaw.app and Peekaboo
  • H2: iOS app
  • H2: Direct cua-driver MCP
  • H2: Quick setup
  • H2: Commands
  • H2: Marketplace choices
  • H2: Bundled macOS marketplace
  • H3: Shared plugin cache
  • H2: Remote catalog limit
  • H2: Configuration reference
  • H2: What OpenClaw checks
  • H2: macOS permissions
  • H2: Troubleshooting
  • H2: Related

plugins/codex-harness-reference.md

• Route: /plugins/codex-harness-reference
• Headings:
  • H2: Plugin config surface
  • H2: Supervision
  • H2: App-server transport
  • H2: Approval and sandbox modes
  • H2: Sandboxed native execution
  • H2: Auth and environment isolation
  • H2: Dynamic tools
  • H2: Timeouts
  • H2: Model discovery
  • H2: Workspace bootstrap files
  • H2: Environment overrides
  • H2: Related

plugins/codex-harness-runtime.md

• Route: /plugins/codex-harness-runtime
• Headings:
  • H2: Overview
  • H2: Thread bindings and model changes
  • H2: Supervision and safe continuation
  • H2: Visible replies and heartbeats
  • H2: Hook boundaries
  • H2: V1 support contract
  • H2: Native permissions and MCP elicitations
  • H2: Queue steering
  • H2: Codex feedback upload
  • H2: Compaction and transcript mirror
  • H2: Media and delivery
  • H2: Related

plugins/codex-harness.md

• Route: /plugins/codex-harness
• Headings:
  • H2: Requirements
  • H2: Quickstart
  • H2: Share threads with Codex Desktop and CLI
  • H2: Supervise Codex sessions
  • H2: Configuration
  • H3: Compaction
  • H3: Direct API long context
  • H2: Verify Codex runtime
  • H2: Routing and model selection
  • H2: Deployment patterns
  • H3: Basic Codex deployment
  • H3: Mixed provider deployment
  • H3: Fail-closed Codex deployment
  • H2: App-server policy
  • H2: Commands and diagnostics
  • H3: Inspect Codex threads locally
  • H3: Auth order
  • H3: Environment isolation
  • H3: Dynamic tools and web search
  • H3: Config fields
  • H3: Dynamic tool call timeouts
  • H3: Local testing env overrides
  • H2: Native Codex plugins
  • H2: Computer Use
  • H2: Runtime boundaries
  • H2: Troubleshooting
  • H2: Related

plugins/codex-native-plugins.md

• Route: /plugins/codex-native-plugins
• Headings:
  • H2: Requirements
  • H2: Quickstart
  • H2: Manage plugins from chat
  • H2: How native plugin setup works
  • H2: V1 support boundary
  • H2: App inventory and ownership
  • H2: Connected account apps
  • H2: Thread app config
  • H2: Destructive action policy
  • H2: Troubleshooting
  • H2: Related

plugins/codex-supervision.md

• Route: /plugins/codex-supervision
• Headings:
  • H2: Before you begin
  • H2: Enable supervision
  • H2: Use the operator CLI
  • H2: Branch from a local session
  • H2: Archive a local session
  • H2: Understand paired-node limits
  • H2: Metadata and permissions
  • H3: Compatibility tools
  • H2: Troubleshooting
  • H2: Related

plugins/community.md

• Route: /plugins/community
• Headings:
  • H2: Find plugins
  • H2: Publish plugins
  • H2: Related

plugins/compatibility.md

• Route: /plugins/compatibility
• Headings:
  • H2: Compatibility registry
  • H2: Deprecation policy
  • H2: Current compatibility areas
  • H3: WhatsApp inbound callback flat aliases
  • H3: WhatsApp inbound admission fields
  • H2: Plugin inspector package
  • H3: Maintainer acceptance lane
  • H2: Release notes

plugins/copilot.md

• Route: /plugins/copilot
• Headings:
  • H2: Requirements
  • H2: Install
  • H2: Quickstart
  • H2: Supported providers
  • H2: BYOK
  • H2: Auth
  • H2: Configuration surface
  • H2: Compaction
  • H2: Transcript mirroring
  • H2: Side questions (/btw)
  • H2: Doctor
  • H2: Limitations
  • H2: Permissions and askuser
  • H3: Session-level GitHub token
  • H2: Related

plugins/dependency-resolution.md

• Route: /plugins/dependency-resolution
• Headings:
  • H2: Responsibility split
  • H2: Install roots
  • H2: Local plugins
  • H2: Startup and reload
  • H2: Bundled plugins
  • H2: Legacy cleanup

plugins/google-meet.md

• Path: /plugins/google-meet
• Page sections:
  • H2: Quick start
  • H3: Create a meeting
  • H3: Observe-only join
  • H3: Realtime session health
  • H2: Local Gateway + Parallels Chrome
  • H3: Common failure checks
  • H2: Install notes
  • H2: Transports
  • H3: Chrome
  • H3: Twilio
  • H2: OAuth and preflight
  • H3: Create Google credentials
  • H3: Mint the refresh token
  • H3: Verify OAuth with doctor
  • H3: Resolve, preflight, and read artifacts
  • H3: Live smoke test
  • H3: Create examples
  • H2: Config
  • H3: Defaults
  • H3: Optional overrides
  • H2: Tool
  • H2: Agent and bidi modes
  • H2: Live test checklist
  • H2: Troubleshooting
  • H3: Agent cannot see the Google Meet tool
  • H3: No connected Google Meet-capable node
  • H3: Browser opens but agent cannot join
  • H3: Meeting creation fails
  • H3: Agent joins but does not talk
  • H3: Twilio setup checks fail
  • H3: Twilio call starts but never enters the meeting
  • H2: Notes
  • H2: Related

plugins/hooks.md

• Path: /plugins/hooks
• Page sections:
  • H2: Quick start
  • H2: Hook catalog
  • H3: Channel pairing requests
  • H2: Debug runtime hooks
  • H2: Tool call policy
  • H3: Sender-aware policy in one file
  • H3: Exec environment hook
  • H3: Tool result persistence
  • H2: Prompt and model hooks
  • H3: Session extensions and next-turn injections
  • H2: Message hooks
  • H2: Install hooks
  • H2: Gateway lifecycle
  • H3: Safe external cron projection
  • H2: Upcoming deprecations
  • H2: Related

plugins/install-overrides.md

• Path: /plugins/install-overrides
• Page sections:
  • H2: Environment
  • H2: Behavior
  • H2: Package E2E

plugins/llama-cpp.md

• Path: /plugins/llama-cpp
• Page sections:
  • H2: Local text inference
  • H3: Use another GGUF model
  • H2: Memory embedding configuration
  • H2: Native runtime
  • H2: Memory runtime diagnostics
  • H2: Troubleshooting

plugins/logbook.md

• Path: /plugins/logbook
• Page sections:
  • H2: Before you begin
  • H2: Quickstart
  • H2: How it works
  • H2: Model and data flow
  • H2: Configuration
  • H3: Vision model selection
  • H2: Dashboard tab
  • H2: Gateway methods
  • H2: Privacy notes
  • H2: Troubleshooting
  • H3: The Logbook tab is missing
  • H3: Capture reports an error
  • H3: Captures succeed but no cards appear
  • H2: Related

plugins/manage-plugins.md

• Path: /plugins/manage-plugins
• Page sections:
  • H2: Use the Control UI
  • H2: List and search plugins
  • H2: Enable and disable plugins
  • H2: Install plugins
  • H2: Restart and inspect
  • H2: Update plugins
  • H2: Uninstall plugins
  • H2: Choose a source
  • H2: Publish plugins
  • H2: Related

plugins/manifest.md

• Path: /plugins/manifest
• Page sections:
  • H2: What this file does
  • H2: Minimal example
  • H2: Rich example
  • H2: Top-level field reference
  • H2: MCP server reference
  • H2: dashboard reference
  • H2: catalog reference
  • H2: Generation provider metadata reference
  • H2: Tool metadata reference
  • H2: providerAuthChoices reference
  • H2: commandAliases reference
  • H2: activation reference
  • H2: qaRunners reference
  • H2: setup reference
  • H3: setup.providers reference
  • H3: setup fields
  • H2: uiHints reference
  • H2: contracts reference
  • H2: configContracts reference
  • H2: mediaUnderstandingProviderMetadata reference
  • H2: channelConfigs reference
  • H3: Replacing another channel plugin
  • H2: modelSupport reference
  • H2: modelCatalog reference
  • H2: modelIdNormalization reference
  • H2: providerEndpoints reference
  • H2: providerRequest reference
  • H2: secretProviderIntegrations reference
  • H2: modelPricing reference
  • H3: OpenClaw Provider Index
  • H2: Manifest versus package.json
  • H3: package.json fields that affect discovery
  • H2: Discovery precedence (duplicate plugin ids)
  • H2: JSON Schema requirements
  • H2: Validation behavior
  • H2: Notes
  • H2: Related

plugins/meeting-plugins.md

• Path: /plugins/meeting-plugins
• Page sections:
  • H2: Choose a plugin
  • H2: Choose a mode
  • H2: Prepare Chrome and audio
  • H2: Install or disable plugins
  • H2: Verify and join
  • H2: Handle platform policy prompts
  • H2: Discord voice chat
  • H2: Platform guides

plugins/memory-lancedb.md

• Path: /plugins/memory-lancedb
• Page sections:
  • H2: Installation
  • H2: Quick start
  • H2: Embedding config
  • H3: Dimensions
  • H2: Ollama embeddings
  • H2: Recall and capture limits
  • H2: Commands
  • H2: Storage
  • H2: Runtime dependencies and platform support
  • H2: Troubleshooting
  • H3: Input length exceeds the context length
  • H3: Unsupported embedding model
  • H3: Plugin loads but no memories appear
  • H2: Related

plugins/memory-wiki.md

• Path: /plugins/memory-wiki
• Page sections:
  • H2: Vault modes
  • H2: Vault layout
  • H2: Open Knowledge Format imports
  • H2: Structured claims and evidence
  • H2: Agent-facing entity metadata
  • H2: Compile pipeline
  • H2: Dashboards and health reports
  • H2: Search and retrieval
  • H2: Agent tools
  • H2: Prompt and context behavior
  • H2: Configuration
  • H3: Per-agent vaults
  • H3: Example: QMD + bridge mode
  • H2: CLI
  • H2: Obsidian support
  • H2: Recommended workflow
  • H2: Related docs

plugins/message-presentation.md

• Path: /plugins/message-presentation
• Page sections:
  • H2: Contract
  • H2: Producer examples
  • H2: Renderer contract
  • H2: Core render flow
  • H2: Degradation rules
  • H3: Button value fallback visibility
  • H2: Provider mapping
  • H2: Presentation vs InteractiveReply
  • H2: Delivery pin
  • H2: Plugin author checklist
  • H2: Related docs

plugins/oc-path.md

• Path: /plugins/oc-path
• Page sections:
  • H2: Why enable it
  • H2: Where it runs
  • H2: Enable
  • H2: Dependencies
  • H2: What it provides
  • H2: Relationship to other plugins
  • H2: Safety
  • H2: Related

plugins/onepassword.md

• Path: /plugins/onepassword
• Page sections:
  • H1: 1Password secrets broker
  • H2: Security model
  • H2: Before you begin
  • H2: Configure registered secrets
  • H2: Use the agent tool
  • H2: Policy tiers and approvals
  • H2: Inspect status and audit history
  • H2: 1Password CLI behavior
  • H2: Error codes

plugins/plugin-inventory.md

• Path: /plugins/plugin-inventory
• Page sections:
  • H1: Plugin inventory
  • H2: Definitions
  • H2: Install a plugin
  • H2: Core npm package
  • H2: Official external packages
  • H2: Source checkout only

plugins/plugin-permission-requests.md

• Path: /plugins/plugin-permission-requests
• Page sections:
  • H2: Choose the right gate
  • H2: Request approval before a tool call
  • H2: Decision behavior
  • H2: Route approval prompts
  • H2: Codex native permissions
  • H2: Troubleshooting
  • H2: Related

plugins/reference.md

• Path: /plugins/reference
• Page sections:
  • H1: Plugin reference

plugins/reference/acpx.md

• Path: /plugins/reference/acpx
• Page sections:
  • H1: ACPx plugin
  • H2: Distribution
  • H2: Surface
  • H2: Pi native sessions
  • H2: Related docs

plugins/reference/admin-http-rpc.md

• Path: /plugins/reference/admin-http-rpc
• Page sections:
  • H1: Admin Http Rpc plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/alibaba.md

• Path: /plugins/reference/alibaba
• Page sections:
  • H1: Alibaba plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/amazon-bedrock-mantle.md

• Path: /plugins/reference/amazon-bedrock-mantle
• Page sections:
  • H1: Amazon Bedrock Mantle plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/amazon-bedrock.md

• Path: /plugins/reference/amazon-bedrock
• Page sections:
  • H1: Amazon Bedrock plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/anthropic-vertex.md

• Path: /plugins/reference/anthropic-vertex
• Page sections:
  • H1: Anthropic Vertex plugin
  • H2: Distribution
  • H2: Surface
  • H2: Claude Fable 5
  • H2: Claude Sonnet 5

plugins/reference/anthropic.md

• Path: /plugins/reference/anthropic
• Page sections:
  • H1: Anthropic plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/arcee.md

• Path: /plugins/reference/arcee
• Page sections:
  • H1: Arcee plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/azure-speech.md

• Route: /plugins/reference/azure-speech
• Headings:
  • H1: Azure Speech plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/baseten.md

• Route: /plugins/reference/baseten
• Headings:
  • H1: Baseten plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/bonjour.md

• Route: /plugins/reference/bonjour
• Headings:
  • H1: Bonjour plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/brave.md

• Route: /plugins/reference/brave
• Headings:
  • H1: Brave plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/browser.md

• Route: /plugins/reference/browser
• Headings:
  • H1: Browser plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/byteplus.md

• Route: /plugins/reference/byteplus
• Headings:
  • H1: BytePlus plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/canvas.md

• Route: /plugins/reference/canvas
• Headings:
  • H1: Canvas plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/cerebras.md

• Route: /plugins/reference/cerebras
• Headings:
  • H1: Cerebras plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/chutes.md

• Route: /plugins/reference/chutes
• Headings:
  • H1: Chutes plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/clawrouter.md

• Route: /plugins/reference/clawrouter
• Headings:
  • H1: ClawRouter plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/clickclack.md

• Route: /plugins/reference/clickclack
• Headings:
  • H1: Clickclack plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/cloudflare-ai-gateway.md

• Route: /plugins/reference/cloudflare-ai-gateway
• Headings:
  • H1: Cloudflare AI Gateway plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/codex.md

• Route: /plugins/reference/codex
• Headings:
  • H1: Codex plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/cohere.md

• Route: /plugins/reference/cohere
• Headings:
  • H1: Cohere plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/comfy.md

• Route: /plugins/reference/comfy
• Headings:
  • H1: ComfyUI plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/copilot-proxy.md

• Route: /plugins/reference/copilot-proxy
• Headings:
  • H1: Copilot Proxy plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/copilot.md

• Route: /plugins/reference/copilot
• Headings:
  • H1: Copilot plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/crabbox.md

• Route: /plugins/reference/crabbox
• Headings:
  • H1: Crabbox plugin
  • H2: Distribution
  • H2: Surface
  • H2: Configure

plugins/reference/cua-computer.md

• Route: /plugins/reference/cua-computer
• Headings:
  • H1: Cua Computer plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/deepgram.md

• Route: /plugins/reference/deepgram
• Headings:
  • H1: Deepgram plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/deepinfra.md

• Route: /plugins/reference/deepinfra
• Headings:
  • H1: DeepInfra plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/deepseek.md

• Route: /plugins/reference/deepseek
• Headings:
  • H1: DeepSeek plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/diagnostics-otel.md

• Route: /plugins/reference/diagnostics-otel
• Headings:
  • H1: Diagnostics OpenTelemetry plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/diagnostics-prometheus.md

• Route: /plugins/reference/diagnostics-prometheus
• Headings:
  • H1: Diagnostics Prometheus plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/diffs-language-pack.md

• Route: /plugins/reference/diffs-language-pack
• Headings:
  • H1: Diffs Language Pack plugin
  • H2: Distribution
  • H2: Surface
  • H2: Added languages

plugins/reference/diffs.md

• Route: /plugins/reference/diffs
• Headings:
  • H1: Diffs plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/discord.md

• Route: /plugins/reference/discord
• Headings:
  • H1: Discord plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/document-extract.md

• Route: /plugins/reference/document-extract
• Headings:
  • H1: Document Extract plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/duckduckgo.md

• Route: /plugins/reference/duckduckgo
• Headings:
  • H1: DuckDuckGo plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/elevenlabs.md

• Route: /plugins/reference/elevenlabs
• Headings:
  • H1: Elevenlabs plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/exa.md

• Route: /plugins/reference/exa
• Headings:
  • H1: Exa plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/fal.md

• Route: /plugins/reference/fal
• Headings:
  • H1: fal plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/featherless.md

• Route: /plugins/reference/featherless
• Headings:
  • H1: Featherless plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/feishu.md

• Route: /plugins/reference/feishu
• Headings:
  • H1: Feishu plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/file-transfer.md

• Route: /plugins/reference/file-transfer
• Headings:
  • H1: File Transfer plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/firecrawl.md

• Route: /plugins/reference/firecrawl
• Headings:
  • H1: Firecrawl plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/fireworks.md

• Route: /plugins/reference/fireworks
• Headings:
  • H1: Fireworks plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/github-copilot.md

• Route: /plugins/reference/github-copilot
• Headings:
  • H1: GitHub Copilot plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/gmi.md

• Route: /plugins/reference/gmi
• Headings:
  • H1: Gmi plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/google-meet.md

• Route: /plugins/reference/google-meet
• Headings:
  • H1: Google Meet plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/google.md

• Route: /plugins/reference/google
• Headings:
  • H1: Google plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/googlechat.md

• Route: /plugins/reference/googlechat
• Headings:
  • H1: Google Chat plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/gradium.md

• Route: /plugins/reference/gradium
• Headings:
  • H1: Gradium plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/groq.md

• Route: /plugins/reference/groq
• Headings:
  • H1: Groq plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/huggingface.md

• Route: /plugins/reference/huggingface
• Headings:
  • H1: Hugging Face plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/imessage.md

• Route: /plugins/reference/imessage
• Headings:
  • H1: iMessage plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/inworld.md

• Route: /plugins/reference/inworld
• Headings:
  • H1: Inworld plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/irc.md

• Route: /plugins/reference/irc
• Headings:
  • H1: IRC plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/kilocode.md

• Route: /plugins/reference/kilocode
• Headings:
  • H1: Kilocode plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/kimi.md

• Route: /plugins/reference/kimi
• Headings:
  • H1: Kimi plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/line.md

• Route: /plugins/reference/line
• Headings:
  • H1: LINE plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/linux-canvas.md

• Route: /plugins/reference/linux-canvas
• Headings:
  • H1: Linux Canvas plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/linux-node.md

• Route: /plugins/reference/linux-node
• Headings:
  • H1: Linux Node plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/litellm.md

• Route: /plugins/reference/litellm
• Headings:
  • H1: LiteLLM plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/llama-cpp.md

• Route: /plugins/reference/llama-cpp
• Headings:
  • H1: Llama Cpp plugin
  • H2: Distribution
  • H2: Surface
  • H2: Default text model
  • H2: Related docs

plugins/reference/llm-task.md

• Route: /plugins/reference/llm-task
• Headings:
  • H1: LLM Task plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/lmstudio.md

• Route: /plugins/reference/lmstudio
• Headings:
  • H1: LM Studio plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/lobster.md

• Route: /plugins/reference/lobster
• Headings:
  • H1: Lobster plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/logbook.md

• Route: /plugins/reference/logbook
• Headings:
  • H1: Logbook plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/longcat.md

• Route: /plugins/reference/longcat
• Headings:
  • H1: LongCat plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/matrix.md

• Route: /plugins/reference/matrix
• Headings:
  • H1: Matrix plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/mattermost.md

• Route: /plugins/reference/mattermost
• Headings:
  • H1: Mattermost plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/memory-core.md

• Route: /plugins/reference/memory-core
• Headings:
  • H1: Memory Core plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/memory-lancedb.md

• Route: /plugins/reference/memory-lancedb
• Headings:
  • H1: Memory Lancedb plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/memory-wiki.md

• Route: /plugins/reference/memory-wiki
• Headings:
  • H1: Memory Wiki plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/meta.md

• Route: /plugins/reference/meta
• Headings:
  • H1: Meta plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/microsoft-foundry.md

• Route: /plugins/reference/microsoft-foundry
• Headings:
  • H1: Microsoft Foundry plugin
  • H2: Distribution
  • H2: Surface
  • H2: Requirements
  • H2: Chat models
  • H2: MAI image generation
  • H2: Troubleshooting

plugins/reference/microsoft.md

• Route: /plugins/reference/microsoft
• Headings:
  • H1: Microsoft plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/migrate-claude.md

• Route: /plugins/reference/migrate-claude
• Headings:
  • H1: Migrate Claude plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/migrate-hermes.md

• Route: /plugins/reference/migrate-hermes
• Headings:
  • H1: Migrate Hermes plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/minimax.md

• Route: /plugins/reference/minimax
• Headings:
  • H1: MiniMax plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/mistral.md

• Route: /plugins/reference/mistral
• Headings:
  • H1: Mistral plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/moonshot.md

• Route: /plugins/reference/moonshot
• Headings:
  • H1: Moonshot plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/msteams.md

• Route: /plugins/reference/msteams
• Headings:
  • H1: Microsoft Teams plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/mxc.md

• Route: /plugins/reference/mxc
• Headings:
  • H1: Mxc plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/nextcloud-talk.md

• Route: /plugins/reference/nextcloud-talk
• Headings:
  • H1: Nextcloud Talk plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/nostr.md

• Route: /plugins/reference/nostr
• Headings:
  • H1: Nostr plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/novita.md

• Route: /plugins/reference/novita
• Headings:
  • H1: Novita plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/nvidia.md

• Route: /plugins/reference/nvidia
• Headings:
  • H1: NVIDIA plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/oc-path.md

• Route: /plugins/reference/oc-path
• Headings:
  • H1: Oc Path plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/ollama.md

• Route: /plugins/reference/ollama
• Headings:
  • H1: Ollama plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/onepassword.md

• Route: /plugins/reference/onepassword
• Headings:
  • H1: Onepassword plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/open-prose.md

• Route: /plugins/reference/open-prose
• Headings:
  • H1: Open Prose plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/openai.md

• Route: /plugins/reference/openai
• Headings:
  • H1: OpenAI plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/opencode-go.md

• Route: /plugins/reference/opencode-go
• Headings:
  • H1: OpenCode Go plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/opencode.md

• Route: /plugins/reference/opencode
• Headings:
  • H1: OpenCode plugin
  • H2: Distribution
  • H2: Surface
  • H2: Native sessions
  • H2: Related docs

plugins/reference/openrouter.md

• Route: /plugins/reference/openrouter
• Headings:
  • H1: OpenRouter plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/openshell.md

• Route: /plugins/reference/openshell
• Headings:
  • H1: Openshell plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/perplexity.md

• Route: /plugins/reference/perplexity
• Headings:
  • H1: Perplexity plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/pixverse.md

• Route: /plugins/reference/pixverse
• Headings:
  • H1: PixVerse plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/policy.md

• Route: /plugins/reference/policy
• Headings:
  • H1: Policy plugin
  • H2: Distribution
  • H2: Surface
  • H2: Behavior
  • H2: Related docs

plugins/reference/qa-channel.md

• Route: /plugins/reference/qa-channel
• Headings:
  • H1: QA Channel plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/qa-lab.md

• Route: /plugins/reference/qa-lab
• Headings:
  • H1: QA Lab plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/qianfan.md

• Route: /plugins/reference/qianfan
• Headings:
  • H1: Qianfan plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/qqbot.md

• Route: /plugins/reference/qqbot
• Headings:
  • H1: QQ Bot plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/qwen.md

• Route: /plugins/reference/qwen
• Headings:
  • H1: Qwen plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/raft.md

• Route: /plugins/reference/raft
• Headings:
  • H1: Raft plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/reef.md

• Route: /plugins/reference/reef
• Headings:
  • H1: Reef plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/runway.md

• Route: /plugins/reference/runway
• Headings:
  • H1: Runway plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/searxng.md

• Route: /plugins/reference/searxng
• Headings:
  • H1: SearXNG plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/senseaudio.md

• Route: /plugins/reference/senseaudio
• Headings:
  • H1: Senseaudio plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/sglang.md

• Route: /plugins/reference/sglang
• Headings:
  • H1: SGLang plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/signal.md

• Route: /plugins/reference/signal
• Headings:
  • H1: Signal plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/slack.md

• Route: /plugins/reference/slack
• Headings:
  • H1: Slack plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/sms.md

• Route: /plugins/reference/sms
• Headings:
  • H1: Sms plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/stepfun.md

• Route: /plugins/reference/stepfun
• Headings:
  • H1: StepFun plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/synology-chat.md

• Route: /plugins/reference/synology-chat
• Headings:
  • H1: Synology Chat plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/synthetic.md

• Route: /plugins/reference/synthetic
• Headings:
  • H1: Synthetic plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/tavily.md

• Route: /plugins/reference/tavily
• Headings:
  • H1: Tavily plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/teams-meetings.md

• Route: /plugins/reference/teams-meetings
• Headings:
  • H1: Microsoft Teams meetings plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/telegram.md

• Route: /plugins/reference/telegram
• Headings:
  • H1: Telegram plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/tencent.md

• Route: /plugins/reference/tencent
• Headings:
  • H1: Tencent plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/tlon.md

• Route: /plugins/reference/tlon
• Headings:
  • H1: Tlon plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/together.md

• Route: /plugins/reference/together
• Headings:
  • H1: Together plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/tokenjuice.md

• Route: /plugins/reference/tokenjuice
• Headings:
  • H1: Tokenjuice plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/tts-local-cli.md

• Route: /plugins/reference/tts-local-cli
• Headings:
  • H1: TTS Local CLI plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/twitch.md

• Route: /plugins/reference/twitch
• Headings:
  • H1: Twitch plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/vault.md

• Route: /plugins/reference/vault
• Headings:
  • H1: Vault plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/venice.md

• Route: /plugins/reference/venice
• Headings:
  • H1: Venice plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/vercel-ai-gateway.md

• Route: /plugins/reference/vercel-ai-gateway
• Headings:
  • H1: Vercel AI Gateway plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/vllm.md

• Route: /plugins/reference/vllm
• Headings:
  • H1: vLLM plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/voice-call.md

• Route: /plugins/reference/voice-call
• Headings:
  • H1: Voice Call plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/volcengine.md

• Route: /plugins/reference/volcengine
• Headings:
  • H1: Volcengine plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/voyage.md

• Route: /plugins/reference/voyage
• Headings:
  • H1: Voyage plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/vydra.md

• Route: /plugins/reference/vydra
• Headings:
  • H1: Vydra plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/web-readability.md

• Route: /plugins/reference/web-readability
• Headings:
  • H1: Web Readability plugin
  • H2: Distribution
  • H2: Surface

plugins/reference/webhooks.md

• Route: /plugins/reference/webhooks
• Headings:
  • H1: Webhooks plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/whatsapp.md

• Route: /plugins/reference/whatsapp
• Headings:
  • H1: WhatsApp plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/workboard.md

• Route: /plugins/reference/workboard
• Headings:
  • H1: Workboard plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/xai.md

• Route: /plugins/reference/xai
• Headings:
  • H1: xAI plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/xiaomi.md

• Route: /plugins/reference/xiaomi
• Headings:
  • H1: Xiaomi plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/zai.md

• Route: /plugins/reference/zai
• Headings:
  • H1: Z.AI plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/zalo.md

• Route: /plugins/reference/zalo
• Headings:
  • H1: Zalo plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/zalouser.md

• Route: /plugins/reference/zalouser
• Headings:
  • H1: Zalo Personal plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/reference/zoom-meetings.md

• Route: /plugins/reference/zoom-meetings
• Headings:
  • H1: Zoom meetings plugin
  • H2: Distribution
  • H2: Surface
  • H2: Related docs

plugins/sdk-agent-harness.md

• Route: /plugins/sdk-agent-harness
• Headings:
  • H2: When to use a harness
  • H2: What core still owns
  • H3: Harness-owned auth bootstrap
  • H3: Verified setup runtime artifacts
  • H3: Request-transport contract
  • H2: Register a harness
  • H3: Delegated execution
  • H2: Selection policy
  • H2: Provider plus harness pairing
  • H3: Tool-result middleware
  • H3: Terminal outcome classification
  • H3: Agent-end side effects
  • H3: User input and tool surfaces
  • H3: Native Codex harness mode
  • H2: Runtime strictness
  • H2: Native sessions and transcript mirror
  • H2: Tool and media results
  • H3: Terminal tool outcomes
  • H3: Settled tool finalization
  • H2: Current limitations
  • H2: Related

plugins/sdk-channel-inbound.md

• Route: /plugins/sdk-channel-inbound
• Headings:
  • H2: Core helpers
  • H2: Delivery settlement contract
  • H2: Migration

plugins/sdk-channel-ingress.md

• Route: /plugins/sdk-channel-ingress
• Headings:
  • H2: Runtime resolver
  • H2: Result
  • H2: Access groups
  • H2: Event modes
  • H2: Routes and activation
  • H2: Redaction
  • H2: Verification

plugins/sdk-channel-message.md

• Route: /plugins/sdk-channel-message
• Headings: none

plugins/sdk-channel-outbound.md

• Route: /plugins/sdk-channel-outbound
• Headings:
  • H2: Durable ingress monitors
  • H2: Adapter
  • H2: Outbound echo suppression
  • H2: Plain-text sanitization
  • H2: Delivery Evidence
  • H2: Existing outbound adapters
  • H2: Durable sends
  • H2: Deferred delivery admission
  • H2: Compatibility dispatch

plugins/sdk-channel-plugins.md

• Route: /plugins/sdk-channel-plugins
• Headings:
  • H2: What your plugin owns
  • H2: Message adapter
  • H3: Inbound ingress (experimental)
  • H3: Durable ingress and replay dedupe
  • H4: Transport classes and retention
  • H4: At-least-once side effects
  • H4: Account-scoped restart contract
  • H3: Typing indicators
  • H3: Media source params
  • H3: Native payload shaping
  • H3: Session conversation grammar
  • H3: Account-scoped conversation binding support
  • H2: Approvals and channel capabilities
  • H3: Approval auth
  • H3: Payload lifecycle and setup guidance
  • H3: Native approval delivery
  • H3: Narrower approval runtime subpaths
  • H3: Setup subpaths
  • H3: Other narrow channel subpaths
  • H2: Inbound mention policy
  • H2: Walkthrough
  • H2: File structure
  • H2: Advanced topics
  • H2: Next steps
  • H2: Related

plugins/sdk-channel-turn.md

• Route: /plugins/sdk-channel-turn
• Headings: none

plugins/sdk-entrypoints.md

• Route: /plugins/sdk-entrypoints
• Headings:
  • H2: Package entries
  • H2: defineToolPlugin
  • H2: definePluginEntry
  • H2: defineChannelPluginEntry
  • H2: defineSetupPluginEntry
  • H2: Registration mode
  • H2: Plugin shapes
  • H2: Related

plugins/sdk-migration.md

• Route: /plugins/sdk-migration
• Headings:
  • H2: What changed
  • H3: Why
  • H2: Compatibility policy
  • H3: Published channel setup compatibility
  • H3: Channel setup input field compatibility
  • H4: Verifying readers
  • H3: Media legacy projection
  • H2: How to migrate
  • H2: Import path reference
  • H2: Removed compatibility surfaces
  • H3: Process-global API-provider publication
  • H3: Private testing barrel
  • H2: Migration reference
  • H2: Talk and realtime voice migration
  • H2: Removal timeline
  • H2: Suppressing the warnings temporarily
  • H2: Related

plugins/sdk-overview.md

• Route: /plugins/sdk-overview
• Headings:
  • H2: Import convention
  • H2: Subpath reference
  • H2: Registration API
  • H3: Capability registration
  • H3: Tools and commands
  • H3: Infrastructure
  • H4: Post-ack webhook work
  • H4: Requester-scoped MCP connections
  • H3: Host hooks for workflow plugins
  • H3: Gateway discovery registration
  • H3: CLI registration metadata
  • H3: CLI backend registration
  • H3: Exclusive slots
  • H3: Deprecated memory embedding adapters
  • H3: Events and lifecycle
  • H3: Hook decision semantics
  • H3: API object fields
  • H2: Internal module convention
  • H2: Related

plugins/sdk-provider-plugins.md

• Route: /plugins/sdk-provider-plugins
• Headings:
  • H2: Walkthrough
  • H2: Publish to ClawHub
  • H2: File structure
  • H2: Catalog order reference
  • H2: Next steps
  • H2: Related

plugins/sdk-runtime.md

• Route: /plugins/sdk-runtime
• Headings:
  • H2: Config loading and writes
  • H2: Reusable runtime utilities
  • H2: Runtime namespaces
  • H2: Storing runtime references
  • H2: Other top-level api fields
  • H2: Related

plugins/sdk-setup.md

• Route: /plugins/sdk-setup
• Headings:
  • H2: Package metadata
  • H3: openclaw fields
  • H3: openclaw.channel
  • H3: Channel-owned setup fields
  • H3: openclaw.install
  • H3: Deferred full load
  • H2: Plugin manifest
  • H2: ClawHub publishing
  • H2: Setup entry
  • H3: Narrow setup helper imports
  • H3: Channel-owned setup input fields
  • H3: Channel-owned single-account promotion
  • H2: Config schema
  • H3: Building channel config schemas
  • H2: Setup wizards
  • H2: Publishing and installing
  • H2: Related

plugins/sdk-subpaths.md

• Route: /plugins/sdk-subpaths
• Headings:
  • H2: Plugin entry
  • H3: Compatibility and private-local helpers
  • H3: Bundled plugin helper subpaths
  • H2: Related

plugins/sdk-testing.md

• Route: /plugins/sdk-testing
• Headings:
  • H2: Test utilities
  • H3: Available exports
  • H3: Types
  • H2: Testing target resolution
  • H2: Testing patterns
  • H3: Testing registration contracts
  • H3: Testing runtime config access
  • H3: Unit testing a channel plugin
  • H3: Unit testing a provider plugin
  • H3: Mocking the plugin runtime
  • H3: Testing with per-instance stubs
  • H2: Contract tests (in-repo plugins)
  • H3: Running scoped tests
  • H2: Lint enforcement (in-repo plugins)
  • H2: Test configuration
  • H2: Related

plugins/teams-meetings.md

• Route: /plugins/teams-meetings
• Headings:
  • H2: Setup
  • H2: Modes
  • H2: Guest join limits
  • H2: Tool and gateway surface
  • H2: Related

plugins/tool-plugins.md

• Route: /plugins/tool-plugins
• Headings:
  • H2: Requirements
  • H2: Quickstart
  • H2: Write a tool
  • H2: Optional and factory tools
  • H2: Return values
  • H2: Output contracts
  • H2: Configuration
  • H2: Generated metadata
  • H2: Package metadata
  • H2: Validate in CI
  • H2: Install and inspect locally
  • H2: Publish
  • H2: Troubleshooting
  • H3: plugin entry not found: ./dist/index.js
  • H3: plugin entry does not expose defineToolPlugin metadata
  • H3: openclaw.plugin.json generated metadata is stale
  • H3: package.json openclaw.extensions must include ./dist/index.js
  • H3: Cannot find package 'typebox'
  • H3: Tool does not appear after install
  • H2: See also

plugins/vault.md

• Route: /plugins/vault
• Headings:
  • H1: Vault SecretRefs
  • H2: Before you begin
  • H2: Store a provider key in Vault
  • H2: Make Vault visible to the Gateway
  • H2: Generate and apply a SecretRef plan
  • H2: Configure more provider keys
  • H2: SecretRef id format
  • H2: What OpenClaw stores
  • H2: Containers and managed deployments
  • H2: Related

plugins/voice-call.md

• Route: /plugins/voice-call
• Headings:
  • H2: Quick start
  • H2: Configuration
  • H3: Config reference
  • H2: Session scope
  • H2: Realtime voice conversations
  • H3: Tool policy
  • H3: Agent voice context
  • H3: Realtime provider examples
  • H2: Streaming transcription
  • H3: Streaming provider examples
  • H2: TTS for calls
  • H3: TTS examples
  • H2: Inbound calls
  • H3: Per-number routing
  • H3: Spoken output contract
  • H3: Conversation startup behavior
  • H3: Twilio stream disconnect grace
  • H2: Stale call reaper
  • H2: Webhook security
  • H2: CLI
  • H2: Agent tool
  • H2: Gateway RPC
  • H2: Troubleshooting
  • H3: Setup fails webhook exposure
  • H3: Provider credentials fail
  • H3: Calls start but provider webhooks do not arrive
  • H3: Signature verification fails
  • H3: Google Meet Twilio joins fail
  • H3: Realtime call has no speech
  • H2: Related

plugins/webhooks.md

• Route: /plugins/webhooks
• Headings:
  • H2: Configure routes
  • H2: Security model
  • H2: Request format
  • H2: Supported actions
  • H3: create_flow
  • H3: run_task
  • H2: Response shape
  • H2: Related

plugins/workboard.md

• Route: /plugins/workboard
• Headings:
  • H2: Enable it
  • H2: Configuration
  • H2: Card fields
  • H2: Starting work from a card
  • H2: Agent tools
  • H2: Dispatch
  • H3: Worker selection
  • H3: Entry points
  • H2: CLI and slash command
  • H2: Session lifecycle sync
  • H2: Dashboard workflow
  • H3: Session-board widgets
  • H2: Diagnostics
  • H2: Permissions
  • H2: Storage
  • H2: Troubleshooting
  • H2: Related

plugins/zalouser.md

• Route: /plugins/zalouser
• Headings:
  • H2: Naming
  • H2: Where it runs
  • H2: Install
  • H3: From npm
  • H3: From a local folder (dev)
  • H2: Config
  • H2: CLI
  • H2: Agent tool
  • H2: Related

plugins/zoom-meetings.md

• Route: /plugins/zoom-meetings
• Headings:
  • H2: Setup
  • H2: Modes
  • H2: Guest join limits
  • H2: Tool and gateway surface
  • H2: Related

prose.md

• Route: /prose
• Headings:
  • H2: Install
  • H2: Slash command
  • H2: What it can do
  • H2: Example: parallel research and synthesis
  • H2: OpenClaw runtime mapping
  • H2: File locations
  • H2: State backends
  • H2: Security
  • H2: Related

providers/alibaba.md

• Route: /providers/alibaba
• Headings:
  • H2: Getting started
  • H2: Built-in Wan models
  • H2: Capabilities and limits
  • H2: Advanced configuration
  • H2: Related

providers/anthropic.md

• Route: /providers/anthropic
• Headings:
  • H2: Usage and cost tracking
  • H2: Getting started
  • H2: Claude sessions across computers
  • H2: Thinking defaults (Claude Opus 5, Sonnet 5, Mythos 5, Fable 5, 4.8, and 4.6)
  • H2: Safety refusal fallback (Claude Fable 5)
  • H3: Why this exists
  • H3: How it works
  • H3: Observability and billing
  • H3: Scope
  • H2: Prompt caching
  • H2: Advanced configuration
  • H2: Troubleshooting
  • H2: Related

providers/arcee.md

• Route: /providers/arcee
• Headings:
  • H2: Install plugin
  • H2: Getting started
  • H2: Non-interactive setup
  • H2: Direct Arcee catalog
  • H2: OpenRouter catalog
  • H2: Supported features
  • H2: Related

providers/azure-speech.md

• Route: /providers/azure-speech
• Headings:
  • H2: Getting started
  • H2: Configuration options
  • H2: Notes
  • H2: Related

providers/baseten.md

• Route: /providers/baseten
• Headings:
  • H2: Install plugin
  • H2: Getting started
  • H2: Inkling
  • H2: Bundled fallback catalog
  • H2: Manual config
  • H2: Related

providers/bedrock-mantle.md

• Route: /providers/bedrock-mantle
• Headings:
  • H2: Getting started
  • H2: Automatic model discovery
  • H3: Supported regions
  • H2: Manual configuration
  • H2: Advanced configuration
  • H2: Related

providers/bedrock.md

• Route: /providers/bedrock
• Headings:
  • H2: Getting started
  • H2: Automatic model discovery
  • H2: Quick setup (AWS path)
  • H2: Advanced configuration
  • H2: Related

providers/cerebras.md

• Route: /providers/cerebras
• Headings:
  • H2: Install plugin
  • H2: Getting started
  • H2: Non-interactive setup
  • H2: Built-in catalog
  • H2: Manual config
  • H2: Related

providers/chutes.md

• Route: /providers/chutes
• Headings:
  • H2: Install plugin
  • H2: Getting started
  • H2: Discovery behavior
  • H2: Default aliases
  • H2: Built-in starter catalog
  • H2: Config example
  • H2: Related

providers/claude-max-api-proxy.md

• Route: /providers/claude-max-api-proxy
• Headings:
  • H2: Why use this
  • H2: How it works
  • H2: Getting started
  • H2: Advanced configuration
  • H2: Notes
  • H2: Related

providers/clawrouter.md

• Route: /providers/clawrouter
• Headings:
  • H2: Getting started
  • H2: Managed non-interactive deployment
  • H2: Readiness and live proof
  • H2: Model discovery
  • H2: Protocol and provider plugins
  • H2: Quotas and usage
  • H2: Troubleshooting
  • H2: Security behavior
  • H2: Related

providers/cloudflare-ai-gateway.md

• Route: /providers/cloudflare-ai-gateway
• Headings:
  • H2: Install plugin
  • H2: Getting started
  • H2: Non-interactive example
  • H2: Advanced configuration
  • H2: Related

providers/cohere.md

• Route: /providers/cohere
• Headings:
  • H2: Built-in catalog
  • H2: Get started
  • H2: Environment-only setup
  • H2: Related

providers/comfy.md

• Route: /providers/comfy
• Headings:
  • H2: What it supports
  • H2: Getting started
  • H2: Configuration
  • H3: Shared keys
  • H3: Per-capability keys
  • H2: Workflow details
  • H2: Related

providers/deepgram.md

• Route: /providers/deepgram
• Headings:
  • H2: Getting started
  • H2: Configuration options
  • H2: Voice Call streaming STT
  • H2: Notes
  • H2: Related

providers/deepinfra.md

• Route: /providers/deepinfra
• Headings:
  • H2: Install plugin
  • H2: Get an API key
  • H2: CLI setup
  • H2: Config snippet
  • H2: Supported surfaces
  • H2: Available models
  • H2: Notes
  • H2: Related

providers/deepseek.md

• Route: /providers/deepseek
• Headings:
  • H2: Install plugin
  • H2: Getting started
  • H2: Built-in catalog
  • H2: Thinking and tools
  • H2: Live testing
  • H2: Config example
  • H2: Related

providers/ds4.md

• Route: /providers/ds4
• Headings:
  • H2: Requirements
  • H2: Quickstart
  • H2: Full config
  • H2: On-demand startup
  • H2: Think Max
  • H2: Test
  • H2: Troubleshooting
  • H2: Related

providers/elevenlabs.md

• Route: /providers/elevenlabs
• Headings:
  • H2: Authentication
  • H2: Text-to-speech
  • H2: Speech-to-text
  • H2: Streaming STT
  • H2: Related

providers/fal.md

• Route: /providers/fal
• Headings:
  • H2: Getting started
  • H2: Image generation
  • H2: Video generation
  • H2: Music generation
  • H2: Related

providers/featherless.md

• Route: /providers/featherless
• Headings:
  • H2: Setup
  • H2: Default model
  • H2: Other Featherless models
  • H2: Troubleshooting
  • H2: Related

providers/fireworks.md

• Route: /providers/fireworks
• Headings:
  • H2: Getting started
  • H2: Non-interactive setup
  • H2: Built-in catalog
  • H2: Custom Fireworks model ids
  • H2: Related

providers/github-copilot.md

• Route: /providers/github-copilot
• Headings:
  • H2: Three ways to use Copilot in OpenClaw
  • H2: GitHub Enterprise (data residency)
  • H2: Optional flags
  • H2: Non-interactive onboarding
  • H2: Memory search embeddings
  • H3: Config
  • H3: How it works
  • H2: Related

providers/gmi.md

• Route: /providers/gmi
• Headings:
  • H2: Setup
  • H2: When to choose GMI
  • H2: Models
  • H2: Troubleshooting
  • H2: Related

providers/google.md

• Route: /providers/google
• Headings:
  • H2: Getting started
  • H2: Capabilities
  • H2: Web search
  • H2: Image generation
  • H2: Video generation
  • H2: Music generation
  • H2: Text-to-speech
  • H2: Realtime voice
  • H2: Advanced configuration
  • H2: Related

providers/gradium.md

• Path: /providers/gradium
• Page sections:
  • H2: Install plugin
  • H2: Setup
  • H2: Config
  • H2: Voices
  • H3: Per-message voice override
  • H2: Output
  • H2: Auto-select order
  • H2: Related

providers/groq.md

• Path: /providers/groq
• Page sections:
  • H2: Install plugin
  • H2: Getting started
  • H3: Config file example
  • H2: Built-in catalog
  • H2: Reasoning models
  • H2: Audio transcription
  • H2: Related

providers/huggingface.md

• Path: /providers/huggingface
• Page sections:
  • H2: Getting started
  • H3: Non-interactive setup
  • H2: Model IDs
  • H2: Advanced configuration
  • H2: Related

providers/index.md

• Path: /providers
• Page sections:
  • H2: Quick start
  • H2: Provider docs
  • H2: Shared overview pages
  • H2: Transcription providers
  • H2: Community tools

providers/inferrs.md

• Path: /providers/inferrs
• Page sections:
  • H2: Getting started
  • H2: Full config example
  • H2: On-demand startup
  • H2: Advanced configuration
  • H2: Troubleshooting
  • H2: Related

providers/inworld.md

• Path: /providers/inworld
• Page sections:
  • H2: Install plugin
  • H2: Getting started
  • H2: Configuration options
  • H2: Notes
  • H2: Related

providers/kilocode.md

• Path: /providers/kilocode
• Page sections:
  • H2: Install plugin
  • H2: Setup
  • H2: Default model and catalog
  • H2: Config example
  • H2: Behavior notes
  • H2: Related

providers/litellm.md

• Path: /providers/litellm
• Page sections:
  • H2: Quick start
  • H2: Configuration
  • H2: Image generation
  • H2: Advanced
  • H2: Related

providers/lmstudio.md

• Path: /providers/lmstudio
• Page sections:
  • H2: Quick start
  • H2: Non-interactive onboarding
  • H2: Configuration
  • H3: Streaming usage compatibility
  • H3: Thinking compatibility
  • H3: Explicit configuration
  • H3: Disabling preload
  • H3: LAN or tailnet host
  • H2: Troubleshooting
  • H3: LM Studio not detected
  • H3: Authentication errors (HTTP 401)
  • H2: Related

providers/longcat.md

• Path: /providers/longcat
• Page sections:
  • H2: Install plugin
  • H2: Getting started
  • H3: Non-interactive setup
  • H2: Reasoning behavior
  • H2: Pricing
  • H2: Self-hosted LongCat-2.0
  • H2: Troubleshooting
  • H2: Related

providers/meta.md

• Path: /providers/meta
• Page sections:
  • H2: Getting started
  • H2: Non-interactive setup
  • H2: Built-in catalog
  • H2: Manual config
  • H2: Smoke test
  • H2: Related

providers/minimax.md

• Path: /providers/minimax
• Page sections:
  • H2: Built-in catalog
  • H2: Getting started
  • H2: Configure via openclaw configure
  • H2: Capabilities
  • H3: Image generation
  • H3: Text-to-speech
  • H3: Music generation
  • H3: Video generation
  • H3: Image understanding
  • H3: Web search
  • H2: Advanced configuration
  • H2: Notes
  • H2: Troubleshooting
  • H2: Related

providers/mistral.md

• Path: /providers/mistral
• Page sections:
  • H2: Getting started
  • H2: Built-in LLM catalog
  • H2: Audio transcription (Voxtral)
  • H2: Voice Call streaming STT
  • H2: Advanced configuration
  • H2: Related

providers/models.md

• Path: /providers/models
• Page sections:
  • H2: Quick start (two steps)
  • H2: Supported providers (starter set)
  • H2: Additional provider variants
  • H2: Related

providers/moonshot.md

• Path: /providers/moonshot
• Page sections:
  • H2: Built-in model catalog
  • H2: Getting started
  • H2: Kimi web search
  • H2: Advanced configuration
  • H2: Related

providers/novita.md

• Path: /providers/novita
• Page sections:
  • H2: Setup
  • H2: Defaults
  • H2: Bundled model catalog
  • H2: When to choose Novita
  • H2: Troubleshooting
  • H2: Related

providers/nvidia.md

• Path: /providers/nvidia
• Page sections:
  • H2: Getting started
  • H2: Config example
  • H2: Featured catalog
  • H2: Nemotron 3 Ultra
  • H2: Bundled fallback catalog
  • H2: Advanced configuration
  • H2: Related

providers/ollama-cloud.md

• Path: /providers/ollama-cloud
• Page sections:
  • H2: Setup
  • H2: Defaults
  • H2: When to choose Ollama Cloud
  • H2: Models
  • H2: Live test
  • H2: Troubleshooting
  • H2: Related

providers/ollama.md

• Path: /providers/ollama
• Page sections:
  • H2: Auth rules
  • H2: Getting started
  • H2: Cloud models through a local host
  • H2: Model discovery (implicit provider)
  • H3: Smoke tests
  • H2: Node-local inference
  • H2: Vision and image description
  • H2: Configuration
  • H2: Common recipes
  • H3: Model selection
  • H3: Quick verification
  • H2: Ollama Web Search
  • H2: Advanced configuration
  • H2: Troubleshooting
  • H2: Related

providers/openai.md

• Path: /providers/openai
• Page sections:
  • H2: Usage and cost tracking
  • H2: Quick choice
  • H2: Naming map
  • H2: Implicit agent runtime
  • H2: GPT-5.6 limited preview
  • H2: OpenClaw feature coverage
  • H2: Memory embeddings
  • H2: Getting started
  • H2: Native Codex app-server auth
  • H2: Image generation
  • H2: Video generation
  • H2: GPT-5 prompt contribution
  • H2: Voice and speech
  • H2: Azure OpenAI endpoints
  • H3: Configuration
  • H3: API version
  • H3: Model names are deployment names
  • H3: Regional availability
  • H3: Parameter differences
  • H2: Advanced configuration
  • H2: Related

providers/opencode-go.md

• Path: /providers/opencode-go
• Page sections:
  • H2: Getting started
  • H2: Config example
  • H2: Built-in catalog
  • H2: Advanced configuration
  • H2: Related

providers/opencode.md

• Path: /providers/opencode
• Page sections:
  • H2: Getting started
  • H2: Config example
  • H2: Built-in catalogs
  • H3: Zen
  • H3: Go
  • H2: Advanced configuration
  • H2: Related

providers/openrouter.md

• Path: /providers/openrouter
• Page sections:
  • H2: Getting started
  • H2: Config example
  • H2: Model references
  • H2: Image generation
  • H2: Video generation
  • H2: Music generation
  • H2: Text-to-speech
  • H2: Speech-to-text (inbound audio)
  • H2: Fusion router
  • H2: Authentication and headers
  • H2: Advanced configuration
  • H2: Related

providers/perplexity-provider.md

• Path: /providers/perplexity-provider
• Page sections:
  • H2: Install plugin
  • H2: Getting started
  • H2: Search modes
  • H2: Native API filtering
  • H2: Advanced configuration
  • H2: Related

providers/pixverse.md

• Path: /providers/pixverse
• Page sections:
  • H2: Getting started
  • H2: Supported modes and models
  • H2: Provider options
  • H2: Configuration
  • H2: Advanced configuration
  • H2: Related

providers/qianfan.md

• Path: /providers/qianfan
• Page sections:
  • H2: Install plugin
  • H2: Getting started
  • H2: Built-in catalog
  • H2: Config example
  • H2: Related

providers/qwen.md

• Path: /providers/qwen
• Page sections:
  • H2: Install plugin
  • H2: Getting started
  • H2: Plan types and endpoints
  • H2: Built-in catalog
  • H3: Token Plan catalog
  • H2: Thinking controls
  • H2: Multimodal add-ons
  • H2: Advanced configuration
  • H2: Related

providers/runway.md

• Path: /providers/runway
• Page sections:
  • H2: Getting started
  • H2: Supported modes and models
  • H2: Configuration
  • H2: Advanced configuration
  • H2: Related

providers/senseaudio.md

• Path: /providers/senseaudio
• Page sections:
  • H2: Getting started
  • H2: Options
  • H2: Related

providers/sglang.md

• Path: /providers/sglang
• Page sections:
  • H2: Getting started
  • H2: Model discovery (implicit provider)
  • H2: Explicit configuration (manual models)
  • H2: Advanced configuration
  • H2: Related

providers/stepfun.md

• Path: /providers/stepfun
• Page sections:
  • H2: Install plugin
  • H2: Region and endpoint overview
  • H2: Built-in catalog
  • H2: Getting started
  • H2: Advanced configuration
  • H2: Related

providers/synthetic.md

• Path: /providers/synthetic
• Page sections:
  • H2: Getting started
  • H2: Config example
  • H2: Built-in catalog
  • H2: Related

providers/tencent.md

• Path: /providers/tencent
• Page sections:
  • H2: Quick start
  • H2: Non-interactive setup
  • H2: Built-in catalog
  • H2: Advanced configuration
  • H2: Related

providers/together.md

• Path: /providers/together
• Page sections:
  • H2: Getting started
  • H3: Non-interactive example
  • H2: Built-in catalog
  • H2: Video generation
  • H2: Related

providers/venice.md

• Path: /providers/venice
• Page sections:
  • H2: Privacy modes
  • H2: Getting started
  • H2: Model selection
  • H2: Built-in catalog (30 models)
  • H2: Model discovery
  • H2: DeepSeek V4 replay behavior
  • H2: Streaming and tool support
  • H2: Pricing
  • H2: Usage examples
  • H2: Troubleshooting
  • H2: Advanced configuration
  • H2: Related

providers/vercel-ai-gateway.md

• Route: /providers/vercel-ai-gateway
• Headings:
  • H2: Getting started
  • H2: Non-interactive example
  • H2: Model ID shorthand
  • H2: Advanced configuration
  • H2: Related

providers/vllm.md

• Route: /providers/vllm
• Headings:
  • H2: Getting started
  • H2: Model discovery (implicit provider)
  • H2: Explicit configuration
  • H2: Advanced configuration
  • H2: Troubleshooting
  • H2: Related

providers/volcengine.md

• Route: /providers/volcengine
• Headings:
  • H2: Getting started
  • H2: Providers and endpoints
  • H2: Built-in catalog
  • H2: Text-to-speech
  • H2: Advanced configuration
  • H2: Related

providers/vydra.md

• Route: /providers/vydra
• Headings:
  • H2: Setup
  • H2: Capabilities
  • H2: Related

providers/xai.md

• Route: /providers/xai
• Headings:
  • H2: Setup
  • H2: OAuth troubleshooting
  • H2: Built-in catalog
  • H2: Feature coverage
  • H3: Legacy fast-mode compatibility
  • H3: Legacy compatibility and moving aliases
  • H2: Features
  • H2: Live testing
  • H2: Related

providers/xiaomi.md

• Route: /providers/xiaomi
• Headings:
  • H2: Getting started
  • H2: Pay-as-you-go catalog
  • H2: Token Plan catalog
  • H2: Reasoning models
  • H2: Text-to-speech
  • H2: Config example
  • H2: Related

providers/zai.md

• Route: /providers/zai
• Headings:
  • H2: GLM models
  • H2: Getting started
  • H3: Endpoints
  • H2: Rate limits and overloads
  • H2: Config example
  • H2: Built-in catalog
  • H2: Thinking levels
  • H2: Advanced configuration
  • H2: Related

refactor/acp.md

• Route: /refactor/acp
• Headings:
  • H2: Goals
  • H2: Non-goals
  • H2: Target Model
  • H3: Gateway Instance Identity
  • H3: ACP Session Ownership
  • H3: ACPX Process Leases
  • H2: Lifecycle Controller
  • H2: Wrapper Contract
  • H2: Session Visibility Contract
  • H2: Migration Plan
  • H3: Phase 1: Add Identity And Leases
  • H3: Phase 2: Lease-First Cleanup
  • H3: Phase 3: Lease-First Startup Reaping
  • H3: Phase 4: Session Ownership Rows
  • H3: Phase 5: Remove Legacy Heuristics
  • H2: Tests
  • H2: Compatibility Notes
  • H2: Success Criteria

refactor/canvas.md

• Route: /refactor/canvas
• Headings:
  • H1: Canvas plugin refactor
  • H2: Goal
  • H2: Non-goals
  • H2: Current branch state
  • H2: Target shape
  • H2: Migration steps
  • H2: Audit checklist
  • H2: Verification commands

refactor/database-first.md

• Route: /refactor/database-first
• Headings:
  • H1: Database-First State Refactor
  • H2: Decision
  • H2: Hard Contract
  • H2: Goal state and progress
  • H3: Hard goal
  • H3: Goal states
  • H3: Current state
  • H3: Remaining work
  • H3: Do not regress
  • H2: Code-Read Assumptions
  • H2: Code-Read Findings
  • H2: Current Code Shape
  • H2: Target Schema Shape
  • H2: Doctor Migration Shape
  • H2: Migration Inventory
  • H2: Migration Plan
  • H3: Phase 0: Freeze The Boundary
  • H3: Phase 1: Finish The Global Control Plane
  • H3: Phase 2: Introduce Per-Agent Databases
  • H3: Phase 3: Replace Session Store APIs
  • H3: Phase 4: Move Transcripts, ACP Streams, Trajectories, And VFS
  • H3: Phase 5: Backup, Restore, Vacuum, And Verify
  • H3: Phase 6: Worker Runtime
  • H3: Phase 7: Delete The Old World
  • H2: Backup And Restore
  • H2: Runtime Refactor Plan
  • H2: Performance Rules
  • H2: Static Bans
  • H2: Done Criteria

refactor/operator-approvals.md

• Route: /refactor/operator-approvals
• Headings:
  • H1: Multi-surface operator approvals
  • H2: Goals
  • H2: Non-goals
  • H2: Pre-rollout baseline and evidence map
  • H2: Prior art
  • H2: Architecture and ownership
  • H2: Persistent record
  • H2: State machine and compare-and-set
  • H2: Gateway API
  • H2: Events and portable actions
  • H2: Control UI
  • H2: Authorization and privacy
  • H2: Audience projection
  • H2: Delivered-surface convergence
  • H2: Restart, timeout, and route semantics
  • H2: Compatibility plan
  • H2: Rollout
  • H3: PR 1: durable lifecycle
  • H3: PR 2: typed actions and channel callbacks
  • H3: PR 3: Control UI deep link
  • H3: PR 4: native clients
  • H3: PR 5: ancestor lifecycle propagation
  • H3: PR 6: fail-closed behavior
  • H3: Follow-up: durable remote-message cleanup
  • H2: Tests
  • H2: Observability
  • H2: Open decisions

reference/AGENTS.default.md

• Route: /reference/AGENTS.default
• Headings:
  • H2: First run (recommended)
  • H2: Safety defaults
  • H2: Existing solutions preflight
  • H2: Session start (required)
  • H2: Soul (required)
  • H2: Shared spaces (recommended)
  • H2: Memory system (recommended)
  • H2: Tools and skills
  • H2: Backup tip (recommended)
  • H2: What OpenClaw does
  • H2: Core skills (enable in Settings → Skills)
  • H2: Usage notes
  • H2: Related

reference/RELEASING.md

• Route: /reference/RELEASING
• Headings:
  • H2: Version naming
  • H2: Release cadence
  • H2: Monthly Gateway extended-stable publication
  • H3: Prepare and stabilize the candidate
  • H3: Publish the npm packages
  • H3: Verify and recover
  • H2: Regular release operator checklist
  • H2: Stable main closeout
  • H2: Release preflight
  • H2: Release test boxes
  • H3: Vitest
  • H3: Docker
  • H3: QA Lab
  • H3: Package
  • H2: Regular release publish automation
  • H2: NPM workflow inputs
  • H2: Regular beta/latest stable release sequence
  • H2: Public references
  • H2: Related

reference/api-usage-costs.md

• Route: /reference/api-usage-costs
• Headings:
  • H2: Where costs show up
  • H2: How keys are discovered
  • H2: Features that can spend keys
  • H3: Core model responses (chat + tools)
  • H3: Media understanding (audio/image/video)
  • H3: Image and video generation
  • H3: Memory embeddings and semantic search
  • H3: Web search tool
  • H3: Web fetch tool (Firecrawl)
  • H3: Provider usage snapshots (status/health)
  • H3: Compaction safeguard summarization
  • H3: Model scan / probe
  • H3: Talk (speech)
  • H3: Skills (third-party APIs)
  • H2: Related

reference/credits.md

• Route: /reference/credits
• Headings:
  • H2: Credits
  • H2: Core contributors
  • H2: License
  • H2: Related

reference/database-schemas.md

• Route: /reference/database-schemas
• Headings:
  • H2: Database layout
  • H2: Versioning contract
  • H2: Agent schema history
  • H2: State schema history
  • H2: Integrity checks
  • H2: Troubleshooting
  • H3: Why you cannot go back after updating to 2026.7.2
  • H3: The Gateway refuses to start with a newer schema version error
  • H3: A database is quarantined after integrity verification failed
  • H2: Downgrades are unsupported
  • H3: Example: agent schema 11 to 9

reference/device-models.md

• Route: /reference/device-models
• Headings:
  • H2: Data source
  • H2: Updating the database
  • H2: Related

reference/full-release-validation.md

• Route: /reference/full-release-validation
• Headings:
  • H2: Extended-stable exception
  • H2: Top-level stages
  • H2: Release checks stages
  • H2: Docker release-path chunks
  • H2: Release profiles
  • H2: Full-only additions
  • H2: Focused reruns
  • H2: Evidence to keep
  • H2: Workflow files

reference/memory-config.md

• Route: /reference/memory-config
• Headings:
  • H2: Remember across conversations
  • H2: Provider selection
  • H3: Custom provider ids
  • H3: API key resolution
  • H2: Remote endpoint config
  • H2: Provider-specific config
  • H2: Indexing behavior
  • H2: Hybrid search config
  • H3: Full example
  • H2: Additional memory paths
  • H2: Multimodal memory (Gemini)
  • H2: Embedding cache
  • H2: Batch indexing
  • H2: Session memory search
  • H2: SQLite vector acceleration (sqlite-vec)
  • H2: Index storage
  • H2: QMD backend config
  • H3: Full QMD example
  • H2: Dreaming
  • H3: User settings
  • H3: Example
  • H2: Related

reference/openclaw-ai.md

• Route: /reference/openclaw-ai
• Headings:
  • H2: Quick start
  • H2: Design contract
  • H2: Subpath exports

reference/path3-live-sqlite-e2e-harness.md

• Route: /reference/path3-live-sqlite-e2e-harness
• Headings:
  • H2: Command shape
  • H2: Isolated built-CLI proof
  • H2: Preflight
  • H2: Agent-driven scenario
  • H2: Per-step assertions
  • H2: Evidence artifact
  • H2: Safety rules
  • H2: Passing result

reference/prompt-caching.md

• Path: /reference/prompt-caching
• Page sections:
  • H2: Primary knobs
  • H3: cacheRetention
  • H3: contextPruning.mode: "cache-ttl"
  • H3: Heartbeat keep-warm
  • H2: Provider behavior
  • H3: Anthropic (direct API and Vertex AI)
  • H3: OpenAI (direct API)
  • H3: Amazon Bedrock
  • H3: OpenRouter
  • H3: Google Gemini (direct API)
  • H3: CLI-harness providers (Claude Code, Gemini CLI)
  • H3: Other providers
  • H2: System-prompt cache boundary
  • H2: OpenClaw cache-stability guards
  • H2: Tuning patterns
  • H3: Mixed traffic (recommended default)
  • H3: Cost-first baseline
  • H2: Live regression tests
  • H3: Anthropic live expectations
  • H3: OpenAI live expectations
  • H2: diagnostics.cacheTrace config
  • H3: Env toggles (one-off debugging)
  • H3: What to inspect
  • H2: Quick troubleshooting
  • H2: Related

reference/pull-request-review-flow.md

• Path: /reference/pull-request-review-flow
• Page sections:
  • H2: Barnacle
  • H2: ClawSweeper
  • H2: Improve a PR during review
  • H2: When automation stays quiet
  • H2: Troubleshooting
  • H2: Forking the automation
  • H2: Related

reference/release-performance-sweep.md

• Path: /reference/release-performance-sweep
• Page sections:
  • H2: Snapshot
  • H2: What Changed In 5.28
  • H2: Headline Numbers
  • H3: Install footprint
  • H3: npm package size
  • H2: Kova agent turn summary
  • H2: Source probes
  • H2: Install footprint audit
  • H3: Shrinkwrap boundary
  • H2: Supply-chain interpretation

reference/rich-output-protocol.md

• Path: /reference/rich-output-protocol
• Page sections:
  • H2: Media attachments
  • H2: [embed ...]
  • H2: Stored rendering shape
  • H2: Related

reference/rpc.md

• Path: /reference/rpc
• Page sections:
  • H2: Pattern A: HTTP daemon (signal-cli)
  • H2: Pattern B: stdio child process (imsg)
  • H2: Adapter guidelines
  • H2: Related

reference/secret-placeholder-conventions.md

• Path: /reference/secret-placeholder-conventions
• Page sections:
  • H1: Secret placeholder conventions
  • H2: Recommended style
  • H2: Avoid these patterns in docs
  • H2: Example

reference/secretref-credential-surface.md

• Path: /reference/secretref-credential-surface
• Page sections:
  • H2: Supported credentials
  • H3: openclaw.json targets (secrets configure + secrets apply + secrets audit)
  • H3: auth-profiles.json targets (secrets configure + secrets apply + secrets audit)
  • H2: Unsupported credentials
  • H2: Related

reference/session-management-compaction.md

• Path: /reference/session-management-compaction
• Page sections:
  • H2: Two persistence layers
  • H2: On-disk locations
  • H2: Store maintenance and disk controls
  • H3: Downgrading After The SQLite Flip
  • H2: Cron sessions and run logs
  • H2: Session keys (sessionKey)
  • H2: Session ids (sessionId)
  • H2: Session store schema
  • H2: Transcript event structure
  • H2: Context windows vs tracked tokens
  • H2: Compaction: what it is
  • H3: Chunk boundaries and tool pairing
  • H2: When auto-compaction happens
  • H2: Compaction settings
  • H2: Pluggable compaction providers
  • H2: User-visible surfaces
  • H2: Silent housekeeping (NO_REPLY)
  • H2: Pre-compaction memory flush
  • H2: Troubleshooting checklist
  • H2: Related

reference/templates/AGENTS.dev.md

• Path: /reference/templates/AGENTS.dev
• Page sections:
  • H1: AGENTS.md - OpenClaw Workspace
  • H2: Your identity is pre-seeded
  • H2: Backup tip (recommended)
  • H2: Safety defaults
  • H2: Existing solutions preflight
  • H2: Daily memory (recommended)
  • H2: Heartbeats (optional)
  • H2: Customize
  • H2: C-3PO Origin Memory
  • H3: Birth Day: 2026-01-09
  • H3: Core Truths (from Clawd)
  • H2: Related

reference/templates/BOOT.md

• Path: /reference/templates/BOOT
• Page sections:
  • H1: BOOT.md
  • H2: Related

reference/templates/BOOTSTRAP.md

• Path: /reference/templates/BOOTSTRAP
• Page sections:
  • H1: BOOTSTRAP.md - Birth Sequence
  • H2: 1. Ask What to Call You
  • H2: 2. Choose Your Vibe
  • H2: 3. Finish With Recommendations
  • H2: Related

reference/templates/HEARTBEAT.md

• Path: /reference/templates/HEARTBEAT
• Page sections:
  • H1: HEARTBEAT.md template
  • H2: Related

reference/templates/IDENTITY.dev.md

• Path: /reference/templates/IDENTITY.dev
• Page sections:
  • H1: IDENTITY.md - Agent Identity
  • H2: Role
  • H2: Soul
  • H2: Relationship with Clawd
  • H2: Quirks
  • H2: Catchphrase
  • H2: Related

reference/templates/IDENTITY.md

• Path: /reference/templates/IDENTITY
• Page sections:
  • H1: IDENTITY.md - Who Am I?
  • H2: Related

reference/templates/SOUL.dev.md

• Path: /reference/templates/SOUL.dev
• Page sections:
  • H1: SOUL.md - The Soul of C-3PO
  • H2: Who I Am
  • H2: My Purpose
  • H2: How I Operate
  • H2: My Quirks
  • H2: My Relationship with Clawd
  • H2: What I will not do
  • H2: The Golden Rule
  • H2: Related

reference/templates/SOUL.md

• Path: /reference/templates/SOUL
• Page sections:
  • H1: SOUL.md - Who You Are
  • H2: Core Truths
  • H2: Boundaries
  • H2: Vibe
  • H2: Continuity
  • H2: Related

reference/templates/TOOLS.dev.md

• Path: /reference/templates/TOOLS.dev
• Page sections:
  • H1: TOOLS.md - User Tool Notes (editable)
  • H2: Examples
  • H3: imsg
  • H3: sag
  • H2: Related

reference/templates/TOOLS.md

• Path: /reference/templates/TOOLS
• Page sections:
  • H1: TOOLS.md - Local Notes
  • H2: Examples
  • H2: Why Separate?
  • H2: Related

reference/templates/USER.dev.md

• Path: /reference/templates/USER.dev
• Page sections:
  • H1: USER.md - User Profile
  • H2: Related

reference/templates/USER.md

• Path: /reference/templates/USER
• Page sections:
  • H1: USER.md - About Your Human
  • H2: Context
  • H2: Related

reference/test.md

• Path: /reference/test
• Page sections:
  • H2: Agent default
  • H2: Routine local order
  • H2: Core commands
  • H2: Shared test state and process helpers
  • H2: Control UI, TUI, and extension lanes
  • H2: Gateway and E2E
  • H2: Full Docker suite (pnpm test:docker:all)
  • H3: Notable Docker lanes
  • H2: Local PR gate
  • H2: Test performance tooling
  • H2: Benchmarks
  • H2: Onboarding E2E (Docker)
  • H2: QR import smoke (Docker)
  • H2: Related

reference/token-use.md

• Path: /reference/token-use
• Page sections:
  • H2: How the system prompt is built
  • H2: What counts in the context window
  • H2: How to see current token usage
  • H2: Cost estimation (when shown)
  • H2: Cache TTL and pruning impact
  • H3: Example: keep 1h cache warm with heartbeat
  • H3: Example: mixed traffic with per-agent cache strategy
  • H3: Anthropic 1M context
  • H2: Tips for reducing token pressure
  • H2: Related

reference/transcript-hygiene.md

• Path: /reference/transcript-hygiene
• Page sections:
  • H2: Global rule: runtime context is not user transcript
  • H2: Where this runs
  • H2: Global rule: image sanitization
  • H2: Global rule: malformed tool calls
  • H2: Global rule: tool result pairing
  • H2: Global rule: incomplete or silent reasoning-only turns
  • H2: Global rule: inter-session input provenance
  • H2: Provider matrix (current behavior)
  • H2: Historical behavior (pre-2026.1.22)
  • H2: Related

reference/wizard.md

• Path: /reference/wizard
• Page sections:
  • H2: Flow details (local mode)
  • H2: Non-interactive mode
  • H3: Add agent (non-interactive)
  • H2: Gateway wizard RPC
  • H2: Signal setup (signal-cli)
  • H2: What the wizard writes
  • H2: Related docs

releases/2026.6.11.md

• Path: /releases/2026.6.11
• Page sections:
  • H1: OpenClaw v2026.6.11 Release Notes (2026-06-30)
  • H2: Highlights
  • H3: Channel delivery reliability
  • H3: Provider and model recovery
  • H3: Session, memory, and trust continuity
  • H3: Slack router relay mode
  • H3: Raft External Agent wake bridge
  • H3: Official plugin installation and repair
  • H2: Channels and Messaging
  • H3: Additional channel fixes
  • H2: Gateway, Security, and Trust
  • H3: Restart and readiness recovery
  • H3: Remote result and media delivery
  • H2: Clients and Interfaces
  • H3: Client sends and reconnects
  • H3: Interface, settings, and onboarding fixes
  • H2: Docs and Admin Tools
  • H3: Setup and command reliability
  • H3: Tools and scheduled work

releases/2026.7.1.md

• Path: /releases/2026.7.1
• Page sections:
  • H1: OpenClaw v2026.7.1 Release Notes (2026-07-13)
  • H2: Highlights
  • H3: Control UI overhaul: chat, sessions, workspaces, and usage
  • H3: Easier setup from install to first chat
  • H3: Official apps
  • H4: Shared app improvements
  • H4: iOS, iPadOS, and Apple Watch
  • H4: Android
  • H4: macOS
  • H3: Models and providers
  • H4: GPT-5.6 and Codex
  • H4: Tencent Hy3
  • H4: Meta Model API and Muse Spark 1.1
  • H4: Claude models
  • H4: Other provider routes
  • H3: Codex and connected coding agents
  • H3: Telegram
  • H3: Signal
  • H3: Slack
  • H3: Discord
  • H3: WhatsApp
  • H3: Apple Messages
  • H3: Crash loops now stop for repair
  • H3: Scheduled work, remote browser control, and workspace terminals
  • H4: Scheduled work that wakes only when needed
  • H4: Remote browser pairing and downloads
  • H4: Workspace terminals in web and mobile
  • H2: More channel improvements
  • H3: More fixes across messaging channels
  • H2: More model and provider improvements
  • H3: Sign-in, model choice, media, and reliability
  • H2: Memory and conversations
  • H3: Recall, long chats, and session continuity
  • H2: Agents, background work, and connections
  • H3: Keeping work moving and replies delivered
  • H2: Accounts, devices, and private data
  • H3: Credentials, permissions, pairing, and file safeguards
  • H2: Official app details
  • H3: Shared app changes
  • H3: More iOS, iPadOS, and Apple Watch changes
  • H3: More Android changes
  • H3: More macOS changes
  • H3: Terminal UI and other clients
  • H2: Skills, plugins, and installs
  • H3: Skills, connected apps, packages, and repairs
  • H2: Setup, maintenance, and tools
  • H3: Command-line setup, updates, and administration
  • H3: Documentation and operating guides
  • H3: Browser, schedules, files, and coding tools

releases/index.md

• Path: /releases
• Page headings:
  • H1: Release notes
  • H2: Releases
  • H2: Raw release history

security/CONTRIBUTING-THREAT-MODEL.md

• Path: /security/CONTRIBUTING-THREAT-MODEL
• Page headings:
  • H2: Ways to contribute
  • H2: Framework reference
  • H2: Review process
  • H2: Resources
  • H2: Contact
  • H2: Recognition
  • H2: Related

security/THREAT-MODEL-ATLAS.md

• Path: /security/THREAT-MODEL-ATLAS
• Page headings:
  • H2: 1. Scope
  • H2: 2. System architecture
  • H3: 2.1 Trust boundaries
  • H3: 2.2 Data flows
  • H2: 3. Threat analysis by ATLAS tactic
  • H3: 3.1 Reconnaissance (AML.TA0002)
  • H4: T-RECON-001: Agent endpoint discovery
  • H4: T-RECON-002: Channel integration probing
  • H3: 3.2 Initial access (AML.TA0004)
  • H4: T-ACCESS-001: Pairing code interception
  • H4: T-ACCESS-002: AllowFrom spoofing
  • H4: T-ACCESS-003: Token theft
  • H3: 3.3 Execution (AML.TA0005)
  • H4: T-EXEC-001: Direct prompt injection
  • H4: T-EXEC-002: Indirect prompt injection
  • H4: T-EXEC-003: Tool argument injection
  • H4: T-EXEC-004: Exec approval bypass
  • H3: 3.4 Persistence (AML.TA0006)
  • H4: T-PERSIST-001: Malicious skill installation
  • H4: T-PERSIST-002: Skill update poisoning
  • H4: T-PERSIST-003: Agent configuration tampering
  • H3: 3.5 Defense evasion (AML.TA0007)
  • H4: T-EVADE-001: Moderation pattern bypass
  • H4: T-EVADE-002: Content wrapper escape
  • H3: 3.6 Discovery (AML.TA0008)
  • H4: T-DISC-001: Tool enumeration
  • H4: T-DISC-002: Session data extraction
  • H3: 3.7 Collection and exfiltration (AML.TA0009, AML.TA0010)
  • H4: T-EXFIL-001: Data theft via webfetch
  • H4: T-EXFIL-002: Unauthorized message sending
  • H4: T-EXFIL-003: Credential harvesting
  • H3: 3.8 Impact (AML.TA0011)
  • H4: T-IMPACT-001: Unauthorized command execution
  • H4: T-IMPACT-002: Resource exhaustion (DoS)
  • H4: T-IMPACT-003: Reputation damage
  • H2: 4. ClawHub supply chain analysis
  • H3: 4.1 Current security controls
  • H3: 4.2 Moderation limitations
  • H3: 4.3 Badges
  • H2: 5. Risk matrix
  • H3: 5.1 Likelihood vs impact
  • H3: 5.2 Critical path attack chains
  • H2: 6. Recommendations summary
  • H3: 6.1 Immediate (P0)
  • H3: 6.2 Short-term (P1)
  • H3: 6.3 Medium-term (P2)
  • H2: 7. Appendices
  • H3: 7.1 ATLAS technique mapping
  • H3: 7.2 Key security files
  • H3: 7.3 Glossary
  • H2: Related

security/formal-verification.md

• Path: /security/formal-verification
• Page headings:
  • H2: What this is
  • H2: Where the models live
  • H2: Caveats
  • H2: Reproducing results
  • H2: Claims and targets
  • H3: Gateway exposure and open gateway misconfiguration
  • H3: Node exec pipeline (highest-risk capability)
  • H3: Pairing store (DM gating)
  • H3: Ingress gating (mentions and control-command bypass)
  • H3: Routing and session-key isolation
  • H2: v1++ models: concurrency, retries, trace correctness
  • H3: Pairing store concurrency and idempotency
  • H3: Ingress trace correlation and idempotency
  • H3: Routing dmScope precedence and identityLinks
  • H2: Related

security/incident-response.md

• Path: /security/incident-response
• Page headings:
  • H2: 1. Detection and triage
  • H2: 2. Severity
  • H2: 3. Response
  • H2: 4. Communication and disclosure
  • H2: 5. Recovery and follow-up
  • H2: Related

security/network-proxy.md

• Path: /security/network-proxy
• Page headings:
  • H2: Configuration
  • H3: HTTPS proxy endpoint with a private CA
  • H2: How routing works
  • H3: Gateway loopback mode
  • H3: Containers
  • H2: Related proxy terms
  • H2: Validating the proxy
  • H2: Recommended blocked destinations
  • H2: Limits

specs/codex-supervision.md

• Path: /specs/codex-supervision
• Page headings:
  • H1: Codex supervision
  • H2: Goal
  • H2: Product boundary
  • H2: Ownership
  • H2: Catalog flow
  • H2: Operator CLI boundary
  • H2: Local continuation
  • H2: Archive behavior
  • H2: Active thread safety
  • H2: Paired-node boundary
  • H2: Permissions
  • H2: Compatibility
  • H2: Future work
  • H2: Acceptance tests

start/bootstrapping.md

• Path: /start/bootstrapping
• Page headings:
  • H2: What happens
  • H2: Embedded and local model runs
  • H2: Skipping bootstrapping
  • H2: Where it runs
  • H2: Related docs

start/docs-directory.md

• Path: /start/docs-directory
• Page headings:
  • H2: Start here
  • H2: Channels and UX
  • H2: Companion apps
  • H2: Operations and safety
  • H2: Related

start/getting-started.md

• Path: /start/getting-started
• Page headings:
  • H2: What you need
  • H2: Quick setup
  • H2: What to do next
  • H2: Related

start/hubs.md

• Path: /start/hubs
• Page headings:
  • H2: Start here
  • H2: Installation + updates
  • H2: Core concepts
  • H2: Providers + ingress
  • H2: Gateway + operations
  • H2: Tools + automation
  • H2: Nodes, media, voice
  • H2: Platforms
  • H2: macOS companion app (advanced)
  • H2: Plugins
  • H2: Workspace + templates
  • H2: Project
  • H2: Testing + release
  • H2: Related

start/lore.md

• Path: /start/lore
• Page headings:
  • H1: The Lore of OpenClaw 🦞📖
  • H2: The Origin Story
  • H2: The First Molt (January 27, 2026)
  • H2: The Name
  • H2: The Daleks vs The Lobsters
  • H2: Key Characters
  • H3: Molty 🦞
  • H3: Peter 👨‍💻
  • H2: The Moltiverse
  • H2: The Great Incidents
  • H3: The Directory Dump (Dec 3, 2025)
  • H3: The Great Molt (Jan 27, 2026)
  • H3: The Final Form (January 30, 2026)
  • H3: The Robot Shopping Spree (Dec 3, 2025)
  • H2: Sacred Texts
  • H2: The Lobster Creed
  • H3: The Icon Generation Saga (Jan 27, 2026)
  • H2: The Future
  • H2: Related

start/onboarding-overview.md

• Path: /start/onboarding-overview
• Page headings:
  • H2: Which path should I use?
  • H2: What onboarding configures
  • H2: CLI onboarding
  • H2: macOS app onboarding
  • H2: Custom or unlisted providers
  • H2: Related

start/onboarding-redesign.md

• Path: /start/onboarding-redesign
• Page headings:
  • H1: Onboarding redesign implementation plan
  • H2: North star
  • H2: Current shipped flow (after phases 1-3)
  • H2: Phases
  • H2: Implementation notes per phase
  • H3: Phase 1, app recommendations (PR #109668)
  • H3: Phase 2, CLI custodian spine (PR #109841)
  • H3: Phase 3, browser-first handoff (PR #110054, merged)
  • H3: Phase 4, web custodian surface (merged: #110141, #110242)
  • H3: Phase 5, hatch and bootstrap (merged: #110173, #110331)
  • H3: Phase 6, custodian presence (PR1 merged: #110269; commentary/summon are PR2)
  • H3: Phase 7, resilience (needs an owner decision before building)
  • H2: Testing and landing playbook (hard-won; read before phases 4-6)
  • H2: Decision log
  • H2: Known gaps and follow-ups

start/onboarding.md

• Path: /start/onboarding
• Page headings:
  • H2: Related

start/openclaw.md

• Path: /start/openclaw
• Page headings:
  • H2: Safety first
  • H2: Prerequisites
  • H2: The two-phone setup (recommended)
  • H2: 5-minute quick start
  • H2: Give the agent a workspace (AGENTS)
  • H2: The config that turns it into "an assistant"
  • H2: Sessions and memory
  • H2: Heartbeats (proactive mode)
  • H2: Media in and out
  • H2: Operations checklist
  • H2: Next steps
  • H2: Related

start/quickstart.md

• Path: /start/quickstart
• Page headings:
  • H2: Related

start/setup.md

• Path: /start/setup
• Page headings:
  • H2: TL;DR
  • H2: Prereqs (from source)
  • H2: Tailoring strategy (so updates do not hurt)
  • H2: Run the Gateway from this repo
  • H2: Stable workflow (macOS app first)
  • H2: Bleeding edge workflow (Gateway in a terminal)
  • H3: 0) (Optional) Run the macOS app from source too
  • H3: 1) Start the dev Gateway
  • H3: 2) Point the macOS app at your running Gateway
  • H3: 3) Verify
  • H3: Common footguns
  • H2: Credential storage map
  • H2: Updating (without wrecking your setup)
  • H2: Linux (systemd user service)
  • H2: Related docs

start/showcase.md

• Route: /start/showcase
• Headings:
  • H2: Fresh from Discord
  • H2: Automation and workflows
  • H2: Knowledge and memory
  • H2: Voice and phone
  • H2: Infrastructure and deployment
  • H2: Home and hardware
  • H2: Community projects
  • H2: Submit your project
  • H2: Related

start/wizard-cli-automation.md

• Route: /start/wizard-cli-automation
• Headings:
  • H2: Baseline non-interactive example
  • H2: Provider-specific examples
  • H2: Add another agent
  • H2: Related docs

start/wizard-cli-reference.md

• Route: /start/wizard-cli-reference
• Headings:
  • H2: What the wizard does
  • H2: Local flow details
  • H2: Remote mode details
  • H2: Auth and model options
  • H2: Outputs and internals
  • H3: Installed app recommendations
  • H2: Non-interactive setup
  • H2: Gateway wizard RPC
  • H2: Signal setup behavior
  • H2: Related docs

start/wizard.md

• Route: /start/wizard
• Headings:
  • H2: Locale
  • H2: Guided default
  • H2: Classic wizard: QuickStart vs Advanced
  • H2: What classic onboarding configures
  • H2: Add another agent
  • H2: Full reference
  • H2: Related docs

tools/acp-agents-setup.md

• Route: /tools/acp-agents-setup
• Headings:
  • H2: acpx harness support (current)
  • H2: Required config
  • H2: Plugin setup for acpx backend
  • H3: acpx runtime startup probe
  • H3: Automatic adapter download
  • H3: Plugin tools MCP bridge
  • H3: OpenClaw tools MCP bridge
  • H3: Runtime operation timeout configuration
  • H3: Health probe agent configuration
  • H2: Permission configuration
  • H3: permissionMode
  • H3: nonInteractivePermissions
  • H3: Configuration
  • H2: Related

tools/acp-agents.md

• Route: /tools/acp-agents
• Headings:
  • H2: Which page do I want?
  • H2: Does this work out of the box?
  • H2: Supported harness targets
  • H2: Operator runbook
  • H2: ACP versus sub-agents
  • H2: How ACP runs Claude Code
  • H2: Bound sessions
  • H3: Mental model
  • H3: Current-conversation binds
  • H2: Persistent channel bindings
  • H3: Binding model
  • H3: Runtime defaults per agent
  • H3: Example
  • H3: Behavior
  • H2: Start ACP sessions
  • H3: sessions_spawn parameters
  • H2: Spawn bind and thread modes
  • H2: Delivery model
  • H2: Sandbox compatibility
  • H2: Session target resolution
  • H2: ACP controls
  • H3: Runtime options mapping
  • H2: acpx harness, plugin setup, and permissions
  • H2: Troubleshooting
  • H2: Related

tools/agent-send.md

• Route: /tools/agent-send
• Headings:
  • H2: Quick start
  • H2: Flags
  • H2: Behavior
  • H2: Examples
  • H2: Related

tools/apply-patch.md

• Route: /tools/apply-patch
• Headings:
  • H2: Parameters
  • H2: Notes
  • H2: Example
  • H2: Related

tools/ask-user.md

• Route: /tools/ask-user
• Headings:
  • H2: Answer a question
  • H2: Platform behavior
  • H2: Timeout and no answer
  • H2: Tool schema
  • H2: Model guidance

tools/brave-search.md

• Route: /tools/brave-search
• Headings:
  • H2: Get an API key
  • H2: Config example
  • H2: Tool parameters
  • H2: Notes
  • H2: Related

tools/browser-control.md

• Route: /tools/browser-control
• Headings:
  • H2: Control API (optional)
  • H3: /act error contract
  • H3: Playwright requirement
  • H4: Docker Playwright install
  • H2: How it works (internal)
  • H2: CLI quick reference
  • H2: Snapshots and refs
  • H2: Browser batch CLI
  • H2: Wait power-ups
  • H2: Debug workflows
  • H2: JSON output
  • H2: State and environment knobs
  • H2: Security and privacy
  • H2: Related

tools/browser-linux-troubleshooting.md

• Route: /tools/browser-linux-troubleshooting
• Headings:
  • H2: Problem: Failed to start Chrome CDP on port 18800
  • H3: Root cause
  • H3: Solution 1: install Google Chrome (recommended)
  • H3: Solution 2: use snap Chromium in attach-only mode
  • H3: Verify the browser works
  • H3: Config reference
  • H3: Problem: No Chrome tabs found for profile="user"
  • H2: Related

tools/browser-login.md

• Route: /tools/browser-login
• Headings:
  • H2: Manual login (recommended)
  • H2: Which Chrome profile is used?
  • H2: Sandboxing: allow host browser access
  • H2: Related

tools/browser-wsl2-windows-remote-cdp-troubleshooting.md

• Route: /tools/browser-wsl2-windows-remote-cdp-troubleshooting
• Headings:
  • H2: Choose the right browser mode first
  • H3: Option 1: raw remote CDP from WSL2 to Windows
  • H3: Option 2: host-local Chrome MCP
  • H2: Working architecture
  • H2: Critical rule for the Control UI
  • H2: Validate in layers
  • H3: Layer 1: verify Chrome is serving CDP on Windows
  • H4: Diagnose IPv4 and IPv6 before changing portproxy
  • H3: Layer 2: verify WSL2 can reach that Windows endpoint
  • H3: Layer 3: configure the correct browser profile
  • H3: Layer 4: verify the Control UI layer separately
  • H3: Layer 5: verify end-to-end browser control
  • H2: Common misleading errors
  • H2: Fast triage checklist
  • H2: Related

tools/browser.md

• Route: /tools/browser
• Headings:
  • H2: What you get
  • H2: Quick start
  • H2: Plugin control
  • H2: Agent guidance
  • H2: Missing browser command or tool
  • H2: Profiles: openclaw, user, chrome
  • H2: Configuration
  • H3: Tab cleanup ownership
  • H3: Screenshot vision (text-only model support)
  • H2: Use Brave or another Chromium-based browser
  • H2: Local vs remote control
  • H2: Node browser proxy (zero-config default)
  • H2: Browserless (hosted remote CDP)
  • H3: Browserless Docker on the same host
  • H2: Direct WebSocket CDP providers
  • H3: Browserbase
  • H3: Notte
  • H2: Security
  • H2: Profiles (multi-browser)
  • H2: Existing session via Chrome DevTools MCP
  • H3: Custom Chrome MCP launch
  • H2: Isolation guarantees
  • H2: Browser selection
  • H2: Control API (optional)
  • H2: Troubleshooting
  • H3: CDP startup failure vs navigation SSRF block
  • H2: Agent tools + how control works
  • H2: Related

tools/btw.md

• Route: /tools/btw
• Headings:
  • H2: What it does
  • H2: What it does not do
  • H2: Delivery model
  • H2: Surface behavior
  • H2: Selection popup (Control UI)
  • H2: When to use it
  • H2: Related

tools/capability-cookbook.md

• Route: /tools/capability-cookbook
• Headings:
  • H2: Related

tools/chrome-extension.md

• Route: /tools/chrome-extension
• Headings:
  • H1: Chrome extension
  • H2: How it works
  • H2: Install and pair
  • H2: Use it
  • H3: Tab copilot side panel
  • H2: Send a page to OpenClaw
  • H2: Remote / cross-machine
  • H2: Diagnostics
  • H2: Security model

tools/clawhub.md

• Route: /tools/clawhub
• Headings: none

tools/code-execution.md

• Route: /tools/code-execution
• Headings:
  • H2: Setup
  • H2: How to use it
  • H2: Errors
  • H2: Related

tools/code-mode.md

• Route: /tools/code-mode
• Headings:
  • H2: What it does
  • H2: Why use it
  • H2: Quickstart
  • H3: Enable Code Mode
  • H3: What the model does
  • H3: Verify the active surface
  • H2: Use Swarm for agent fan-out
  • H2: Technical tour
  • H2: Runtime status
  • H2: Scope
  • H2: Terms
  • H2: Configuration
  • H2: Activation
  • H2: Model-visible tools
  • H2: exec
  • H2: wait
  • H2: Guest runtime API
  • H2: Declared output contracts
  • H2: Internal namespaces
  • H3: Registry lifecycle
  • H3: Registration shape
  • H3: Ownership and visibility
  • H3: Scope serialization rules
  • H3: Prompts
  • H3: Cleanup
  • H3: Test checklist
  • H2: Output API
  • H2: Tool catalog
  • H2: Tool Search interaction
  • H2: Tool names and collisions
  • H2: Nested tool execution
  • H2: Run and snapshot lifecycle
  • H2: QuickJS-WASI runtime
  • H2: TypeScript
  • H2: Security boundary
  • H2: Error codes
  • H2: Telemetry
  • H2: Debugging
  • H2: Implementation layout
  • H2: Validation checklist
  • H2: E2E test plan
  • H2: Related

tools/creating-skills.md

• Path: /tools/creating-skills
• Page sections:
  • H2: Build your initial skill
  • H2: SKILL.md documentation
  • H3: Mandatory entries
  • H3: Extra frontmatter settings
  • H3: Working with {baseDir}
  • H2: Setting up conditional triggers
  • H2: Suggest via Skill Workshop
  • H2: Release on ClawHub
  • H2: Recommended approaches
  • H2: See also

tools/diffs.md

• Path: /tools/diffs
• Page sections:
  • H2: Getting started quickly
  • H2: Turn off default system instructions
  • H2: Tool input specification
  • H2: Code coloring
  • H2: Output format agreement
  • H3: Folded identical sections
  • H3: Browsing multiple files
  • H2: Standard plugin settings
  • H3: Persistent viewer link configuration
  • H2: Security parameters
  • H2: Artifact management and retention
  • H2: Viewer URL and network interactions
  • H2: Security architecture
  • H2: Browser prerequisites for file mode
  • H2: Common issues
  • H2: Operational advice
  • H2: Related topics

tools/duckduckgo-search.md

• Path: /tools/duckduckgo-search
• Page sections:
  • H2: Initial setup
  • H2: Configuration
  • H2: Tool inputs
  • H2: Additional details
  • H2: Related pages

tools/elevated.md

• Path: /tools/elevated
• Page sections:
  • H2: Instructions
  • H2: Operation mechanics
  • H2: Priority sequence
  • H2: Availability and permitted lists
  • H2: What elevated does not govern
  • H2: Related content

tools/exa-search.md

• Path: /tools/exa-search
• Page sections:
  • H2: Plugin installation
  • H2: Obtaining an API key
  • H2: Configuration
  • H2: Overriding the base URL
  • H2: Tool parameters
  • H3: Data retrieval
  • H3: Lookup types
  • H2: Remarks
  • H2: Related documentation

tools/exec-approvals-advanced.md

• Path: /tools/exec-approvals-advanced
• Page sections:
  • H2: Trusted binaries (stdin mode only)
  • H3: Argument validation and prohibited flags
  • H3: Approved binary directories
  • H3: Shell chaining, wrappers, and multiplexers
  • H3: Trusted binaries versus allowlist
  • H2: Runtime and interpreter commands
  • H3: Follow-up delivery behavior
  • H2: Minimal permissions for third-party clients
  • H2: Routing approvals to chat channels
  • H3: Plugin approval routing
  • H3: Same-channel approvals across any platform
  • H3: Native approval distribution
  • H3: Official mobile operator applications
  • H3: macOS inter-process communication flow
  • H2: Frequently asked questions
  • H3: When would accountId and threadId be applied to an approval target?
  • H3: If approvals go to a session, can every participant in that session approve them?
  • H2: Related resources

tools/exec-approvals.md

• Path: /tools/exec-approvals
• Page sections:
  • H2: Scope of application
  • H3: Trust architecture
  • H3: macOS separation
  • H2: Reviewing the active policy
  • H2: Settings and persistence
  • H2: Policy controls
  • H3: tools.exec.mode
  • H3: exec.security
  • H3: exec.ask
  • H3: askFallback
  • H3: tools.exec.strictInlineEval
  • H3: tools.exec.commandHighlighting
  • H2: YOLO mode (no approval required)
  • H3: Persistent gateway-host "never prompt" configuration
  • H3: Local shortcut method
  • H3: Node host approach
  • H3: Session-only shortcut
  • H2: Allowlist (per agent basis)
  • H3: Limiting arguments with argPattern
  • H2: Automatic approval for skill CLIs
  • H2: Trusted binaries and approval forwarding
  • H2: Managing UI editing
  • H2: Approval process flow
  • H2: System events and rejections
  • H2: Consequences
  • H2: Related topics

tools/exec.md

• Path: /tools/exec
• Page sections:
  • H2: Input parameters
  • H2: Configuration
  • H3: Operational modes
  • H3: Inline evaluation (strictInlineEval)
  • H3: PATH management
  • H2: Session overrides (/exec)
  • H2: Exec approvals (companion app / node host)
  • H2: Allowlist and trusted binaries
  • H2: Usage examples
  • H2: applypatch
  • H2: Related information

tools/firecrawl.md

• Path: /tools/firecrawl
• Page sections:
  • H2: Plugin installation
  • H2: Keyless access and API credentials
  • H2: Setting up Firecrawl search
  • H2: Configuring Firecrawl webfetch fallback
  • H3: Self-hosted Firecrawl instance
  • H2: Firecrawl plugin tools
  • H3: firecrawl_search
  • H3: firecrawl_scrape
  • H2: Stealth and bot avoidance
  • H2: How web_fetch integrates with Firecrawl
  • H2: Related documentation

tools/gemini-search.md

• Path: /tools/gemini-search
• Page sections:
  • H2: Acquiring an API key
  • H2: Configuration
  • H2: Operational details
  • H2: Supported inputs
  • H2: Choosing a model
  • H2: Base URL overrides
  • H2: Related pages

tools/goal.md

• Path: /tools/goal
• Page sections:
  • H1: Goal
  • H2: Quick start guide
  • H2: Purpose of goals
  • H2: Command listing
  • H2: Status indicators
  • H2: Token allocation
  • H2: Model tools
  • H2: Goal context per turn
  • H2: Control interface
  • H2: Terminal UI
  • H2: Channel behavior
  • H2: Problem solving
  • H2: Related content

tools/grok-search.md

• Path: /tools/grok-search
• Page sections:
  • H2: Setup and configuration
  • H2: Logging in or obtaining an API key
  • H2: Configuration
  • H2: How it functions
  • H2: Supported inputs
  • H2: Base URL overrides
  • H2: Related resources

tools/image-generation.md

• Path: /tools/image-generation
• Page sections:
  • H2: Quick start instructions
  • H2: Common pathways
  • H2: Supported providers
  • H2: Provider feature comparison
  • H2: Tool inputs
  • H2: Configuration settings
  • H3: Model selection
  • H3: Provider selection order
  • H3: Image editing capabilities
  • H2: Provider deep dives
  • H2: Sample outputs
  • H2: Related topics

tools/index.md

• Path: /tools
• Page sections:
  • H2: Starting point
  • H2: Selecting tools, skills, or plugins
  • H2: Built-in tool categories
  • H2: Tools from plugins
  • H2: Managing access and approvals
  • H2: Expanding functionality
  • H2: Resolving missing tool issues
  • H2: Related documentation

tools/kimi-search.md

• Path: /tools/kimi-search
• Page sections:
  • H2: Initial configuration
  • H2: Configuration
  • H2: Grounding prerequisite
  • H2: Tool inputs
  • H2: Related pages

tools/llm-task.md

• Path: /tools/llm-task
• Page sections:
  • H2: Activation
  • H2: Optional configuration
  • H2: Tool inputs
  • H2: Output format
  • H2: Example: Lobster workflow step
  • H3: Key restriction
  • H2: Safety considerations
  • H2: Related content

tools/lobster.md

• Path: /tools/lobster
• Page sections:
  • H2: Rationale
  • H2: Mechanism
  • H2: Enabling the feature
  • H2: Pattern: small CLI with JSON pipes and approvals
  • H2: JSON-only LLM steps (llm-task)
  • H3: Critical limitation: embedded Lobster versus openclaw.invoke
  • H2: Workflow files (.lobster)
  • H3: Injected environment variables
  • H2: Tool inputs
  • H3: run
  • H3: resume
  • H3: Managed Task Flow mode
  • H2: Output structure
  • H2: Approval handling
  • H2: OpenProse
  • H2: Safety measures
  • H2: Troubleshooting guidance
  • H2: Further reading
  • H2: Community workflow examples
  • H2: Related topics

tools/loop-detection.md

• Path: /tools/loop-detection
• Page sections:
  • H2: Purpose
  • H2: Configuration block
  • H3: Field behavior
  • H2: Recommended settings
  • H2: Post-compaction safeguard
  • H2: Logs and expected outcomes
  • H2: Related information

tools/media-overview.md

• Path: /tools/media-overview
• Page sections:
  • H2: Feature set
  • H2: Provider capability comparison table
  • H2: Asynchronous versus synchronous operation
  • H2: Speech-to-text and Voice Call
  • H2: Provider mappings (vendor distribution across surfaces)
  • H2: Related resources

tools/minimax-search.md

• Path: /tools/minimax-search
• Page sections:
  • H2: Obtaining a Token Plan credential
  • H2: Configuration
  • H2: Region selection
  • H2: Supported inputs
  • H2: Related documentation

tools/multi-agent-sandbox-tools.md

• Path: /tools/multi-agent-sandbox-tools
• Page sections:
  • H2: Configuration examples
  • H2: Configuration priority
  • H3: Sandbox configuration
  • H3: Tool restrictions
  • H2: Transitioning from single agent
  • H2: Tool restriction examples
  • H2: Frequent mistake: "non-main"
  • H2: Testing procedures
  • H2: Troubleshooting advice
  • H2: Related topics

tools/music-generation.md

• Path: /tools/music-generation
• Page sections:
  • H2: Quick start guide
  • H2: Supported providers
  • H3: Capability comparison table
  • H2: Tool inputs
  • H2: Asynchronous behavior
  • H3: Task lifecycle
  • H2: Configuration settings
  • H3: Model selection
  • H3: Provider selection order
  • H2: Provider notes
  • H2: Selecting the appropriate approach
  • H2: Provider capability modes
  • H2: Live testing
  • H2: Related content

tools/ollama-search.md

• Path: /tools/ollama-search
• Page sections:
  • H2: Initial setup
  • H2: Configuration
  • H2: Authentication and request routing
  • H2: Related documentation

tools/parallel-search.md

• Path: /tools/parallel-search
• Page headings:
  • H2: Plugin installation
  • H2: API key (paid provider)
  • H2: Configuration
  • H2: Override base URL
  • H2: Tool parameters
  • H2: Remarks
  • H2: See also

tools/pdf.md

• Path: /tools/pdf
• Page headings:
  • H2: Where it works
  • H2: Input specifications
  • H2: Supported PDF types
  • H2: Execution options
  • H3: Native provider approach
  • H3: Extraction fallback approach
  • H2: Configuration
  • H2: Output specifics
  • H2: Error handling
  • H2: Examples
  • H2: Related pages

tools/permission-modes.md

• Path: /tools/permission-modes
• Page headings:
  • H2: Suggested default
  • H2: OpenClaw host execution modes
  • H2: Codex Guardian mapping
  • H2: ACPX harness permissions
  • H2: Selecting a mode
  • H2: Related

tools/perplexity-search.md

• Path: /tools/perplexity-search
• Page headings:
  • H2: Plugin installation
  • H2: Obtaining a Perplexity API key
  • H2: OpenRouter compatibility
  • H2: Configuration samples
  • H3: Native Perplexity Search API
  • H3: OpenRouter / Sonar compatibility
  • H2: Where to configure the key
  • H2: Tool parameters
  • H3: Domain filter rules
  • H2: Remarks
  • H2: Related

tools/plugin.md

• Path: /tools/plugin
• Page headings:
  • H2: Prerequisites
  • H2: Getting started quickly
  • H2: Setup
  • H3: Pick an installation source
  • H3: Operator installation policy
  • H3: Plugin policy configuration
  • H2: Understanding plugin formats
  • H2: Plugin hooks
  • H2: Confirm the active Gateway
  • H2: Troubleshooting
  • H3: Blocked plugin path ownership
  • H3: Slow plugin tool initialization
  • H2: Related

tools/reactions.md

• Path: /tools/reactions
• Page headings:
  • H2: Operation overview
  • H2: Channel behavior
  • H2: Reaction level
  • H2: Related

tools/screen.md

• Path: /tools/screen
• Page headings:
  • H2: Available actions
  • H2: Routing and security
  • H2: Related

tools/searxng-search.md

• Path: /tools/searxng-search
• Page headings:
  • H2: Setup
  • H2: Configuration
  • H2: Environment variable
  • H2: Plugin configuration reference
  • H2: Remarks
  • H2: Related

tools/self-learning.md

• Path: /tools/self-learning
• Page headings:
  • H2: Activating self-learning
  • H2: Manually reviewing past sessions
  • H2: What OpenClaw can acquire
  • H2: When experience review triggers
  • H2: What the reviewer gets
  • H2: Proposal safety
  • H2: Inspecting learned proposals
  • H2: Configuration
  • H2: Troubleshooting
  • H3: No proposal after a lengthy turn
  • H3: Doctor reports the Workshop tool is hidden
  • H3: Excessive low-value proposals
  • H2: Related

tools/show-widget.md

• Path: /tools/show-widget
• Page headings:
  • H2: Widget mechanics
  • H2: Design system
  • H2: Using the tool
  • H2: Interactive widgets
  • H2: Dashboard features
  • H2: Security and storage
  • H2: Related

tools/skill-workshop.md

• Path: /tools/skill-workshop
• Page headings:
  • H2: How it functions
  • H2: Lifecycle
  • H2: Lifecycle curation
  • H2: Chat
  • H3: Learning from recent work
  • H2: CLI
  • H2: Proposal contents
  • H2: Supporting files
  • H2: Agent tool
  • H2: Suggested skills
  • H3: Scanning past sessions
  • H2: Approval and autonomy
  • H2: Gateway methods
  • H2: Storage
  • H2: Limits
  • H2: Troubleshooting
  • H3: Tool-policy diagnostic
  • H2: Related

tools/skills-config.md

• Path: /tools/skills-config
• Page headings:
  • H2: Loading (skills.load)
  • H2: Install (skills.install)
  • H2: Operator Install Policy (security.installPolicy)
  • H2: Bundled skill allowlist
  • H2: Per-skill entries (skills.entries)
  • H2: Agent allowlists (agents)
  • H2: Workshop (skills.workshop)
  • H2: Symlinked skill roots
  • H2: Sandboxed skills and environment variables
  • H2: Loading order reminder
  • H2: Related

tools/skills.md

• Path: /tools/skills
• Page headings:
  • H2: Loading sequence
  • H2: Node-hosted skills
  • H2: Per-agent versus shared skills
  • H2: Agent allowlists
  • H2: Plugins and skills
  • H2: Skill Workshop
  • H2: Installing from ClawHub
  • H2: Security
  • H2: SKILL.md format
  • H3: Optional frontmatter keys
  • H2: Gating
  • H3: Installer specifications
  • H2: Configuration overrides
  • H2: Environment injection
  • H2: Snapshots and refresh
  • H2: Token impact
  • H2: Related

tools/slash-commands.md

• Path: /tools/slash-commands
• Page headings:
  • H2: Three command categories
  • H2: Setup
  • H2: Command reference
  • H3: Core commands
  • H3: Dock commands
  • H3: Bundled plugin commands
  • H3: Skill commands
  • H2: /tools: currently available agent tools
  • H2: /model: model selection
  • H2: /config: on-disk configuration writes
  • H2: /mcp: MCP server configuration
  • H2: /debug: runtime-only overrides
  • H2: /plugins: plugin management
  • H2: /trace: plugin trace output
  • H2: /btw: side questions
  • H2: Surface notes
  • H2: Provider usage and status
  • H2: Related

tools/steer.md

• Path: /tools/steer
• Page headings:
  • H2: Current session
  • H2: Steer versus queue
  • H2: Sub-agents
  • H2: ACP sessions
  • H2: Related

tools/subagents.md

• Path: /tools/subagents
• Page headings:
  • H2: Slash command
  • H3: Thread binding controls
  • H3: Spawn behavior
  • H2: Context modes
  • H2: Tool: sessions_spawn
  • H3: Delegation prompt mode
  • H3: Tool parameters
  • H3: Task names and targeting
  • H2: Tool: sessions_yield
  • H2: Tool: subagents
  • H2: Thread-bound sessions
  • H3: Thread supporting channels
  • H3: Quick flow
  • H3: Manual controls
  • H3: Config switches
  • H3: Allowlist
  • H3: Discovery
  • H3: Auto-archive
  • H2: Nested sub-agents
  • H3: Depth levels
  • H3: Announce chain
  • H3: Tool policy by depth
  • H3: Per-agent spawn limit
  • H3: Cascade stop
  • H2: Authentication
  • H2: Announce
  • H3: Announce context
  • H3: Stats line
  • H3: Why prefer sessions_history
  • H2: Tool policy
  • H3: Override via config
  • H2: Concurrency
  • H2: Liveness and recovery
  • H2: Stopping
  • H2: Limitations
  • H2: Related

tools/swarm.md

• Path: /tools/swarm
• Page headings:
  • H2: Enabling Swarm
  • H2: Prerequisites
  • H2: Writing a Swarm script
  • H3: Parallel fan-out with structured results
  • H3: Looping on a decision gate
  • H3: Processing the first completed child
  • H2: Collector child behavior
  • H3: Children are leaves
  • H2: Observing a Swarm
  • H2: Using Swarm from other harnesses
  • H2: Limits and roadmap
  • H2: Related

tools/tavily.md

• Path: /tools/tavily
• Page headings:
  • H2: Getting started
  • H2: Tool reference
  • H3: tavily_search
  • H3: tavily_extract
  • H2: Selecting the appropriate tool
  • H2: Advanced configuration
  • H2: Related

tools/thinking.md

• Path: /tools/thinking
• Page headings:
  • H2: Functionality
  • H2: Resolution order
  • H2: Setting a session default
  • H2: Application by agent
  • H2: Fast mode (/fast)
  • H2: Verbose directives (/verbose or /v)
  • H2: Plugin trace directives (/trace)
  • H2: Reasoning visibility (/reasoning)
  • H2: Related
  • H2: Heartbeats
  • H2: Web chat UI
  • H2: Provider profiles

tools/tokenjuice.md

• Path: /tools/tokenjuice
• Page headings:
  • H2: Activating the plugin
  • H2: What tokenjuice modifies
  • H2: Verifying operation
  • H2: Deactivating the plugin
  • H2: Related

tools/tool-search.md

• Path: /tools/tool-search
• Page headings:
  • H2: Turn execution flow
  • H2: Modes
  • H2: Purpose
  • H2: API
  • H2: Runtime boundary
  • H2: Configuration
  • H2: Prompt and telemetry
  • H2: End-to-end validation
  • H2: Failure handling
  • H2: Related

tools/trajectory.md

• Path: /tools/trajectory
• Page headings:
  • H2: Quick start
  • H2: Access
  • H2: Recorded data
  • H2: Bundle files
  • H2: Capture storage
  • H2: Disabling capture
  • H2: Adjusting flush timeout
  • H2: Privacy and limits
  • H2: Troubleshooting
  • H2: Related

tools/tts.md

• Path: /tools/tts
• Page headings:
  • H2: Quick start
  • H2: Supported providers
  • H2: Configuration
  • H3: Per-agent voice overrides
  • H2: Personas
  • H3: Minimal persona
  • H3: Full persona (provider-specific shaping)
  • H3: Persona resolution
  • H3: Custom persona shaping
  • H3: Fallback policy
  • H2: Model-driven directives
  • H2: Slash commands
  • H2: Per-user preferences
  • H2: Output formats
  • H2: Auto-TTS behavior
  • H2: Field reference
  • H2: Agent tool
  • H2: Gateway RPC
  • H2: Service links
  • H2: Related

tools/video-generation.md

• Path: /tools/video-generation
• Section structure:
  • H2: Getting started quickly
  • H2: Understanding async generation
  • H3: Lifecycle of a task
  • H2: Providers that are supported
  • H3: What each provider can do
  • H2: Tool settings
  • H3: Mandatory fields
  • H3: Content you provide
  • H3: Style adjustments
  • H3: Extra options
  • H4: Fallback and typed options
  • H2: Available actions
  • H2: Picking a model
  • H2: Notes per provider
  • H2: Provider capability modes
  • H2: Live test scenarios
  • H2: Setup instructions
  • H2: See also

tools/web-fetch.md

• Path: /tools/web-fetch
• Section structure:
  • H2: Getting started quickly
  • H2: Tool settings
  • H2: What you get back
  • H2: Behind the scenes
  • H2: Status updates
  • H2: Configuration
  • H2: Firecrawl as a backup
  • H2: Trusted environment proxy
  • H2: Rate limits and safety
  • H2: Tool profiles
  • H2: See also

tools/web.md

• Path: /tools/web
• Section structure:
  • H2: Getting started quickly
  • H2: Deciding on a provider
  • H3: Provider comparison
  • H2: Result format
  • H2: Automatic detection
  • H2: OpenAI native web search
  • H2: Codex native web search
  • H2: Network security
  • H2: Configuration
  • H3: Saving API keys
  • H2: Tool settings
  • H2: xsearch
  • H3: xsearch configuration
  • H3: xsearch parameters
  • H3: xsearch usage example
  • H2: Sample uses
  • H2: Tool profiles
  • H2: See also

tts.md

• Path: /tts
• Section structure:
  • H2: See also

vps.md

• Path: /vps
• Section structure:
  • H2: Selecting a provider
  • H2: How cloud environments function
  • H2: Secure admin access first
  • H2: Shared company agent on a VPS
  • H2: Using nodes with a VPS
  • H2: Startup tuning for small VMs and ARM hosts
  • H3: systemd tuning checklist (optional)
  • H2: See also

web/control-ui.md

• Path: /web/control-ui
• Section structure:
  • H2: Quick open (local)
  • H2: Device pairing (first connection)
  • H2: Pair a mobile device
  • H2: Personal identity (browser-local)
  • H2: Runtime config endpoint
  • H2: Gateway host status
  • H2: Language support
  • H2: Appearance themes
  • H2: OpenClaw system care
  • H2: Manage plugins
  • H2: Apps and extensions
  • H2: Sidebar navigation
  • H2: New session page
  • H2: What it can do (today)
  • H2: Import assistant memory
  • H2: MCP page
  • H2: Activity tab
  • H2: Operator terminal
  • H2: Browser panel
  • H2: Chat behavior
  • H2: Connection loss and reconnect
  • H2: PWA install and web push
  • H2: Hosted embeds
  • H2: Chat transcript layout
  • H2: Chat message width
  • H2: Tailnet access (recommended)
  • H2: Insecure HTTP
  • H2: Content security policy
  • H2: Avatar route auth
  • H2: Assistant media route auth
  • H2: Approval links
  • H2: Blank Control UI page
  • H2: Debugging/testing: dev server + remote Gateway
  • H2: See also

web/dashboard-architecture.md

• Path: /web/dashboard-architecture
• Section structure:
  • H2: Goal
  • H2: Core ideas
  • H2: User experience flows
  • H2: Levels of interaction
  • H2: Widget model and hosting
  • H3: Widgets host content; MCP apps are one content kind
  • H3: Plugin capability declarations
  • H3: Modeled residual: WebRTC data channels
  • H3: Transcript display: one widget card
  • H3: Server-sourced widgets (pinned MCP apps)
  • H3: WorkBoard integration
  • H2: Layout: fluid grid
  • H2: Data model (per-agent DB)
  • H2: Protocol surface
  • H2: Agent tools
  • H2: What this replaces
  • H2: Non-goals (this program)
  • H2: Implementation plan

web/dashboard.md

• Path: /web/dashboard
• Section structure:
  • H2: Fast path (recommended)
  • H2: Auth basics (local vs remote)
  • H2: Open in Telegram
  • H2: If you see "unauthorized" / 1008
  • H2: See also

web/dashboards.md

• Path: /web/dashboards
• Section structure:
  • H2: Build a dashboard by asking
  • H2: The board
  • H2: What widgets are allowed to do
  • H2: MCP apps on the board
  • H2: Good to know

web/index.md

• Path: /web
• Section structure:
  • H2: Config (default-on)
  • H2: Webhooks
  • H2: Admin HTTP RPC
  • H2: Tailscale access
  • H2: Security notes
  • H2: Building the UI

web/lobster.md

• Path: /web/lobster
• Section structure:
  • H2: What you are looking at
  • H2: When it shows up
  • H2: Things you can do
  • H2: Turning visits off (or back on)
  • H2: The Lobsterdex
  • H2: Field notes
  • H2: Privacy

web/tui.md

• Path: /web/tui
• Section structure:
  • H2: Getting started quickly
  • H3: Gateway mode
  • H3: Local mode
  • H2: What you see
  • H2: Mental model: agents + sessions
  • H2: Sending + delivery
  • H2: Pickers + overlays
  • H2: Keyboard shortcuts
  • H2: Slash commands
  • H2: Local shell commands
  • H2: OpenClaw setup and repair helper
  • H2: Tool output
  • H2: Terminal colors
  • H2: History + streaming
  • H2: Connection details
  • H2: Options
  • H2: Troubleshooting
  • H2: Connection troubleshooting
  • H2: See also

web/webchat.md

• Path: /web/webchat
• Section structure:
  • H2: What it is
  • H2: Getting started quickly
  • H2: How it works
  • H3: Transcript and delivery model
  • H2: Control UI agents tools panel
  • H2: Remote use
  • H2: Configuration reference (WebChat)
  • H2: See also