diff --git a/docs/auth-credential-semantics.md b/docs/auth-credential-semantics.md index 4ad9d91f9bb..47698539173 100644 --- a/docs/auth-credential-semantics.md +++ b/docs/auth-credential-semantics.md @@ -6,8 +6,6 @@ read_when: - Debugging model auth failures or profile order --- -# Auth Credential Semantics - This document defines the canonical credential eligibility and resolution semantics used across: - `resolveAuthProfileOrder` diff --git a/docs/automation/auth-monitoring.md b/docs/automation/auth-monitoring.md index ae07f43c43e..70a5b460829 100644 --- a/docs/automation/auth-monitoring.md +++ b/docs/automation/auth-monitoring.md @@ -3,6 +3,4 @@ summary: "Redirect to /gateway/authentication" title: "Auth Monitoring" --- -# Auth Monitoring - This page moved to [Authentication](/gateway/authentication). See [Authentication](/gateway/authentication) for auth monitoring documentation. diff --git a/docs/automation/clawflow.md b/docs/automation/clawflow.md index 0096b6f355e..2fbbfa4a3e7 100644 --- a/docs/automation/clawflow.md +++ b/docs/automation/clawflow.md @@ -3,6 +3,4 @@ summary: "Redirect to Task Flow" title: "ClawFlow" --- -# ClawFlow - ClawFlow was renamed to [Task Flow](/automation/taskflow). See [Task Flow](/automation/taskflow) for the current documentation. diff --git a/docs/automation/cron-vs-heartbeat.md b/docs/automation/cron-vs-heartbeat.md index 2e411d3febf..6acf43ddba7 100644 --- a/docs/automation/cron-vs-heartbeat.md +++ b/docs/automation/cron-vs-heartbeat.md @@ -3,6 +3,4 @@ summary: "Redirect to /automation" title: "Cron vs Heartbeat" --- -# Cron vs Heartbeat - This page moved to [Automation & Tasks](/automation). See [Automation & Tasks](/automation) for the decision guide comparing cron and heartbeat. diff --git a/docs/automation/gmail-pubsub.md b/docs/automation/gmail-pubsub.md index 57dff64eaaf..c2f242bebc8 100644 --- a/docs/automation/gmail-pubsub.md +++ b/docs/automation/gmail-pubsub.md @@ -3,6 +3,4 @@ summary: "Redirect to /automation/cron-jobs" title: "Gmail PubSub" --- -# Gmail PubSub - This page moved to [Scheduled Tasks](/automation/cron-jobs#gmail-pubsub-integration). See [Scheduled Tasks](/automation/cron-jobs#gmail-pubsub-integration) for Gmail PubSub documentation. diff --git a/docs/automation/hooks.md b/docs/automation/hooks.md index 75cfc2d81b2..254b4817b9b 100644 --- a/docs/automation/hooks.md +++ b/docs/automation/hooks.md @@ -6,8 +6,6 @@ read_when: title: "Hooks" --- -# Hooks - Hooks are small scripts that run when something happens inside the Gateway. They can be discovered from directories and inspected with `openclaw hooks`. The Gateway loads internal hooks only after you enable hooks or configure at least one hook entry, hook pack, legacy handler, or extra hook directory. There are two kinds of hooks in OpenClaw: diff --git a/docs/automation/index.md b/docs/automation/index.md index 9ae29c7386e..85b5b8011e2 100644 --- a/docs/automation/index.md +++ b/docs/automation/index.md @@ -7,8 +7,6 @@ read_when: title: "Automation & Tasks" --- -# Automation & Tasks - OpenClaw runs work in the background through tasks, scheduled jobs, event hooks, and standing instructions. This page helps you choose the right mechanism and understand how they fit together. ## Quick decision guide diff --git a/docs/automation/poll.md b/docs/automation/poll.md index df6a1084de8..98f0ceb00b8 100644 --- a/docs/automation/poll.md +++ b/docs/automation/poll.md @@ -3,6 +3,4 @@ summary: "Redirect to /cli/message" title: "Polls" --- -# Polls - This page moved to [Message tool](/cli/message). See [Message tool](/cli/message) for poll documentation. diff --git a/docs/automation/standing-orders.md b/docs/automation/standing-orders.md index 3190f31ff98..583852544dc 100644 --- a/docs/automation/standing-orders.md +++ b/docs/automation/standing-orders.md @@ -7,8 +7,6 @@ read_when: title: "Standing Orders" --- -# Standing Orders - Standing orders grant your agent **permanent operating authority** for defined programs. Instead of giving individual task instructions each time, you define programs with clear scope, triggers, and escalation rules — and the agent executes autonomously within those boundaries. This is the difference between telling your assistant "send the weekly report" every Friday vs. granting standing authority: "You own the weekly report. Compile it every Friday, send it, and only escalate if something looks wrong." diff --git a/docs/automation/taskflow.md b/docs/automation/taskflow.md index d41906c24f4..db7ed41a072 100644 --- a/docs/automation/taskflow.md +++ b/docs/automation/taskflow.md @@ -7,8 +7,6 @@ read_when: title: "Task Flow" --- -# Task Flow - Task Flow is the flow orchestration substrate that sits above [background tasks](/automation/tasks). It manages durable multi-step flows with their own state, revision tracking, and sync semantics while individual tasks remain the unit of detached work. ## When to use Task Flow diff --git a/docs/automation/tasks.md b/docs/automation/tasks.md index 4ba153737cb..abbcad93212 100644 --- a/docs/automation/tasks.md +++ b/docs/automation/tasks.md @@ -7,8 +7,6 @@ read_when: title: "Background Tasks" --- -# Background Tasks - > **Looking for scheduling?** See [Automation & Tasks](/automation) for choosing the right mechanism. This page covers **tracking** background work, not scheduling it. Background tasks track work that runs **outside your main conversation session**: diff --git a/docs/automation/troubleshooting.md b/docs/automation/troubleshooting.md index f9e935d2323..8a9b5715974 100644 --- a/docs/automation/troubleshooting.md +++ b/docs/automation/troubleshooting.md @@ -3,6 +3,4 @@ summary: "Redirect to /automation/cron-jobs" title: "Automation Troubleshooting" --- -# Automation Troubleshooting - This page moved to [Scheduled Tasks](/automation/cron-jobs#troubleshooting). See [Scheduled Tasks](/automation/cron-jobs#troubleshooting) for troubleshooting documentation. diff --git a/docs/automation/webhook.md b/docs/automation/webhook.md index 7f9e16fe31b..55a329b984c 100644 --- a/docs/automation/webhook.md +++ b/docs/automation/webhook.md @@ -3,6 +3,4 @@ summary: "Redirect to /automation/cron-jobs" title: "Webhooks" --- -# Webhooks - This page moved to [Scheduled Tasks](/automation/cron-jobs#webhooks). See [Scheduled Tasks](/automation/cron-jobs#webhooks) for webhook documentation. diff --git a/docs/channels/broadcast-groups.md b/docs/channels/broadcast-groups.md index 2f73c708180..4c916b64126 100644 --- a/docs/channels/broadcast-groups.md +++ b/docs/channels/broadcast-groups.md @@ -7,8 +7,6 @@ status: experimental title: "Broadcast Groups" --- -# Broadcast Groups - **Status:** Experimental **Version:** Added in 2026.1.9 diff --git a/docs/channels/googlechat.md b/docs/channels/googlechat.md index 8ea351bf553..a862ced39de 100644 --- a/docs/channels/googlechat.md +++ b/docs/channels/googlechat.md @@ -5,8 +5,6 @@ read_when: title: "Google Chat" --- -# Google Chat (Chat API) - Status: ready for DMs + spaces via Google Chat API webhooks (HTTP only). ## Quick setup (beginner) diff --git a/docs/channels/groups.md b/docs/channels/groups.md index 128da089632..dbd667e3336 100644 --- a/docs/channels/groups.md +++ b/docs/channels/groups.md @@ -5,8 +5,6 @@ read_when: title: "Groups" --- -# Groups - OpenClaw treats group chats consistently across surfaces: Discord, iMessage, Matrix, Microsoft Teams, Signal, Slack, Telegram, WhatsApp, Zalo. ## Beginner intro (2 minutes) diff --git a/docs/channels/index.md b/docs/channels/index.md index 7dda6dabf33..f2b6f02b53e 100644 --- a/docs/channels/index.md +++ b/docs/channels/index.md @@ -6,8 +6,6 @@ read_when: title: "Chat Channels" --- -# Chat Channels - OpenClaw can talk to you on any chat app you already use. Each channel connects via the Gateway. Text is supported everywhere; media and reactions vary by channel. diff --git a/docs/channels/irc.md b/docs/channels/irc.md index dede197a9a9..cb7aedbe4d0 100644 --- a/docs/channels/irc.md +++ b/docs/channels/irc.md @@ -6,8 +6,6 @@ read_when: - You are configuring IRC allowlists, group policy, or mention gating --- -# IRC - Use IRC when you want OpenClaw in classic channels (`#room`) and direct messages. IRC ships as a bundled plugin, but it is configured in the main config under `channels.irc`. diff --git a/docs/channels/line.md b/docs/channels/line.md index 028d4df9c88..5c4748e5ba6 100644 --- a/docs/channels/line.md +++ b/docs/channels/line.md @@ -7,8 +7,6 @@ read_when: title: LINE --- -# LINE - LINE connects to OpenClaw via the LINE Messaging API. The plugin runs as a webhook receiver on the gateway and uses your channel access token + channel secret for authentication. diff --git a/docs/channels/location.md b/docs/channels/location.md index 87297785ff5..30e3be6cd8d 100644 --- a/docs/channels/location.md +++ b/docs/channels/location.md @@ -6,8 +6,6 @@ read_when: title: "Channel Location Parsing" --- -# Channel location parsing - OpenClaw normalizes shared locations from chat channels into: - terse coordinate text appended to the inbound body, and diff --git a/docs/channels/matrix-push-rules.md b/docs/channels/matrix-push-rules.md index 746802f1758..f35b2125f97 100644 --- a/docs/channels/matrix-push-rules.md +++ b/docs/channels/matrix-push-rules.md @@ -6,8 +6,6 @@ read_when: title: "Matrix push rules for quiet previews" --- -# Matrix push rules for quiet previews - When `channels.matrix.streaming` is `"quiet"`, OpenClaw edits a single preview event in place and marks the finalized edit with a custom content flag. Matrix clients notify on the final edit only if a per-user push rule matches that flag. This page is for operators who self-host Matrix and want to install that rule for each recipient account. If you only want stock Matrix notification behavior, use `streaming: "partial"` or leave streaming off. See [Matrix channel setup](/channels/matrix#streaming-previews). diff --git a/docs/channels/matrix.md b/docs/channels/matrix.md index 761d1f09806..65a677c3501 100644 --- a/docs/channels/matrix.md +++ b/docs/channels/matrix.md @@ -6,8 +6,6 @@ read_when: title: "Matrix" --- -# Matrix - Matrix is a bundled channel plugin for OpenClaw. It uses the official `matrix-js-sdk` and supports DMs, rooms, threads, media, reactions, polls, location, and E2EE. diff --git a/docs/channels/mattermost.md b/docs/channels/mattermost.md index 9955b808f10..c2c35814f11 100644 --- a/docs/channels/mattermost.md +++ b/docs/channels/mattermost.md @@ -6,8 +6,6 @@ read_when: title: "Mattermost" --- -# Mattermost - Status: bundled plugin (bot token + WebSocket events). Channels, groups, and DMs are supported. Mattermost is a self-hostable team messaging platform; see the official site at [mattermost.com](https://mattermost.com) for product details and downloads. diff --git a/docs/channels/nextcloud-talk.md b/docs/channels/nextcloud-talk.md index 8a93e4461f3..fc6c5e5a2fd 100644 --- a/docs/channels/nextcloud-talk.md +++ b/docs/channels/nextcloud-talk.md @@ -5,8 +5,6 @@ read_when: title: "Nextcloud Talk" --- -# Nextcloud Talk - Status: bundled plugin (webhook bot). Direct messages, rooms, reactions, and markdown messages are supported. ## Bundled plugin diff --git a/docs/channels/nostr.md b/docs/channels/nostr.md index 4b1d0dcd105..bdbc9ad5f7b 100644 --- a/docs/channels/nostr.md +++ b/docs/channels/nostr.md @@ -6,8 +6,6 @@ read_when: title: "Nostr" --- -# Nostr - **Status:** Optional bundled plugin (disabled by default until configured). Nostr is a decentralized protocol for social networking. This channel enables OpenClaw to receive and respond to encrypted direct messages (DMs) via NIP-04. diff --git a/docs/channels/pairing.md b/docs/channels/pairing.md index 2ea8b0faeda..18bcf083e78 100644 --- a/docs/channels/pairing.md +++ b/docs/channels/pairing.md @@ -7,8 +7,6 @@ read_when: title: "Pairing" --- -# Pairing - “Pairing” is OpenClaw’s explicit **owner approval** step. It is used in two places: diff --git a/docs/channels/qa-channel.md b/docs/channels/qa-channel.md index 1ed0f3618b4..cb2cd7b6a76 100644 --- a/docs/channels/qa-channel.md +++ b/docs/channels/qa-channel.md @@ -7,8 +7,6 @@ read_when: - You are iterating on end-to-end QA automation --- -# QA Channel - `qa-channel` is a bundled synthetic message transport for automated OpenClaw QA. It is not a production channel. It exists to exercise the same channel plugin diff --git a/docs/channels/qqbot.md b/docs/channels/qqbot.md index b188cbc585a..fe25863718e 100644 --- a/docs/channels/qqbot.md +++ b/docs/channels/qqbot.md @@ -7,8 +7,6 @@ read_when: title: QQ Bot --- -# QQ Bot - QQ Bot connects to OpenClaw via the official QQ Bot API (WebSocket gateway). The plugin supports C2C private chat, group @messages, and guild channel messages with rich media (images, voice, video, files). diff --git a/docs/channels/synology-chat.md b/docs/channels/synology-chat.md index dc6149ebece..8a080351f91 100644 --- a/docs/channels/synology-chat.md +++ b/docs/channels/synology-chat.md @@ -6,8 +6,6 @@ read_when: title: "Synology Chat" --- -# Synology Chat - Status: bundled plugin direct-message channel using Synology Chat webhooks. The plugin accepts inbound messages from Synology Chat outgoing webhooks and sends replies through a Synology Chat incoming webhook. diff --git a/docs/channels/tlon.md b/docs/channels/tlon.md index 9ed57f3ad53..5ef39bcd2e2 100644 --- a/docs/channels/tlon.md +++ b/docs/channels/tlon.md @@ -5,8 +5,6 @@ read_when: title: "Tlon" --- -# Tlon - Tlon is a decentralized messenger built on Urbit. OpenClaw connects to your Urbit ship and can respond to DMs and group chat messages. Group replies require an @ mention by default and can be further restricted via allowlists. diff --git a/docs/channels/troubleshooting.md b/docs/channels/troubleshooting.md index cc6d238a1a8..6a50fd286eb 100644 --- a/docs/channels/troubleshooting.md +++ b/docs/channels/troubleshooting.md @@ -6,8 +6,6 @@ read_when: title: "Channel Troubleshooting" --- -# Channel troubleshooting - Use this page when a channel connects but behavior is wrong. ## Command ladder diff --git a/docs/channels/twitch.md b/docs/channels/twitch.md index 528088f62c8..c8aabd3536e 100644 --- a/docs/channels/twitch.md +++ b/docs/channels/twitch.md @@ -5,8 +5,6 @@ read_when: title: "Twitch" --- -# Twitch - Twitch chat support via IRC connection. OpenClaw connects as a Twitch user (bot account) to receive and send messages in channels. ## Bundled plugin diff --git a/docs/channels/wechat.md b/docs/channels/wechat.md index 22b1664f431..e23000fcdf8 100644 --- a/docs/channels/wechat.md +++ b/docs/channels/wechat.md @@ -7,8 +7,6 @@ read_when: title: "WeChat" --- -# WeChat - OpenClaw connects to WeChat through Tencent's external `@tencent-weixin/openclaw-weixin` channel plugin. diff --git a/docs/channels/whatsapp.md b/docs/channels/whatsapp.md index db998b57706..3425162f895 100644 --- a/docs/channels/whatsapp.md +++ b/docs/channels/whatsapp.md @@ -5,8 +5,6 @@ read_when: title: "WhatsApp" --- -# WhatsApp (Web channel) - Status: production-ready via WhatsApp Web (Baileys). Gateway owns linked session(s). ## Install (on demand) diff --git a/docs/ci.md b/docs/ci.md index f9abc7acff4..42980e883b6 100644 --- a/docs/ci.md +++ b/docs/ci.md @@ -6,8 +6,6 @@ read_when: - You are debugging failing GitHub Actions checks --- -# CI Pipeline - The CI runs on every push to `main` and every pull request. It uses smart scoping to skip expensive jobs when only unrelated areas changed. QA Lab has dedicated CI lanes outside the main smart-scoped workflow. The diff --git a/docs/cli/acp.md b/docs/cli/acp.md index 107621452c9..76468897a9a 100644 --- a/docs/cli/acp.md +++ b/docs/cli/acp.md @@ -6,8 +6,6 @@ read_when: title: "acp" --- -# acp - Run the [Agent Client Protocol (ACP)](https://agentclientprotocol.com/) bridge that talks to an OpenClaw Gateway. This command speaks ACP over stdio for IDEs and forwards prompts to the Gateway diff --git a/docs/cli/index.md b/docs/cli/index.md index dbf7906f7fc..1afc6fec947 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -6,8 +6,6 @@ read_when: title: "CLI Reference" --- -# CLI reference - `openclaw` is the main CLI entry point. Each core command has either a dedicated reference page or is documented with the command it aliases; this index lists the commands, the global flags, and the output styling rules that diff --git a/docs/cli/infer.md b/docs/cli/infer.md index 7a50a9d114e..e9bb07c3140 100644 --- a/docs/cli/infer.md +++ b/docs/cli/infer.md @@ -6,8 +6,6 @@ read_when: title: "Inference CLI" --- -# Inference CLI - `openclaw infer` is the canonical headless surface for provider-backed inference workflows. It intentionally exposes capability families, not raw gateway RPC names and not raw agent tool ids. diff --git a/docs/cli/mcp.md b/docs/cli/mcp.md index 0cd19d5cb16..9307452c4dd 100644 --- a/docs/cli/mcp.md +++ b/docs/cli/mcp.md @@ -7,8 +7,6 @@ read_when: title: "mcp" --- -# mcp - `openclaw mcp` has two jobs: - run OpenClaw as an MCP server with `openclaw mcp serve` diff --git a/docs/cli/sandbox.md b/docs/cli/sandbox.md index 5764851dc70..4c310489c02 100644 --- a/docs/cli/sandbox.md +++ b/docs/cli/sandbox.md @@ -5,8 +5,6 @@ read_when: "You are managing sandbox runtimes or debugging sandbox/tool-policy b status: active --- -# Sandbox CLI - Manage sandbox runtimes for isolated agent execution. ## Overview diff --git a/docs/cli/tasks.md b/docs/cli/tasks.md index af87bee4e6d..bf27c781ae9 100644 --- a/docs/cli/tasks.md +++ b/docs/cli/tasks.md @@ -6,8 +6,6 @@ read_when: title: "`openclaw tasks`" --- -# `openclaw tasks` - Inspect durable background tasks and Task Flow state. With no subcommand, `openclaw tasks` is equivalent to `openclaw tasks list`. diff --git a/docs/concepts/active-memory.md b/docs/concepts/active-memory.md index 03949308672..7b0e8438585 100644 --- a/docs/concepts/active-memory.md +++ b/docs/concepts/active-memory.md @@ -7,8 +7,6 @@ read_when: - You want to tune active memory behavior without enabling it everywhere --- -# Active Memory - Active memory is an optional plugin-owned blocking memory sub-agent that runs before the main reply for eligible conversational sessions. diff --git a/docs/concepts/agent-workspace.md b/docs/concepts/agent-workspace.md index 8b744631c7a..520da32ea05 100644 --- a/docs/concepts/agent-workspace.md +++ b/docs/concepts/agent-workspace.md @@ -6,8 +6,6 @@ read_when: title: "Agent Workspace" --- -# Agent workspace - The workspace is the agent's home. It is the only working directory used for file tools and for workspace context. Keep it private and treat it as memory. diff --git a/docs/concepts/agent.md b/docs/concepts/agent.md index c063d062b64..0e6eeb29186 100644 --- a/docs/concepts/agent.md +++ b/docs/concepts/agent.md @@ -5,8 +5,6 @@ read_when: title: "Agent Runtime" --- -# Agent Runtime - OpenClaw runs a single embedded agent runtime. ## Workspace (required) diff --git a/docs/concepts/architecture.md b/docs/concepts/architecture.md index 7c1c33d3a44..ea675cc1f11 100644 --- a/docs/concepts/architecture.md +++ b/docs/concepts/architecture.md @@ -5,8 +5,6 @@ read_when: title: "Gateway Architecture" --- -# Gateway architecture - ## Overview - A single long‑lived **Gateway** owns all messaging surfaces (WhatsApp via diff --git a/docs/concepts/compaction.md b/docs/concepts/compaction.md index 0f68089c410..25d188ac3de 100644 --- a/docs/concepts/compaction.md +++ b/docs/concepts/compaction.md @@ -6,8 +6,6 @@ read_when: title: "Compaction" --- -# Compaction - Every model has a context window -- the maximum number of tokens it can process. When a conversation approaches that limit, OpenClaw **compacts** older messages into a summary so the chat can continue. diff --git a/docs/concepts/context-engine.md b/docs/concepts/context-engine.md index 1e75e6e4e15..1cb606322b4 100644 --- a/docs/concepts/context-engine.md +++ b/docs/concepts/context-engine.md @@ -7,8 +7,6 @@ read_when: title: "Context Engine" --- -# Context Engine - A **context engine** controls how OpenClaw builds model context for each run. It decides which messages to include, how to summarize older history, and how to manage context across subagent boundaries. diff --git a/docs/concepts/context.md b/docs/concepts/context.md index 29a9635b74d..2b1ca0ec845 100644 --- a/docs/concepts/context.md +++ b/docs/concepts/context.md @@ -7,8 +7,6 @@ read_when: title: "Context" --- -# Context - “Context” is **everything OpenClaw sends to the model for a run**. It is bounded by the model’s **context window** (token limit). Beginner mental model: diff --git a/docs/concepts/delegate-architecture.md b/docs/concepts/delegate-architecture.md index e5c2e9d7a56..f84bc57200c 100644 --- a/docs/concepts/delegate-architecture.md +++ b/docs/concepts/delegate-architecture.md @@ -5,8 +5,6 @@ read_when: "You want an agent with its own identity that acts on behalf of human status: active --- -# Delegate Architecture - Goal: run OpenClaw as a **named delegate** — an agent with its own identity that acts "on behalf of" people in an organization. The agent never impersonates a human. It sends, reads, and schedules under its own account with explicit delegation permissions. This extends [Multi-Agent Routing](/concepts/multi-agent) from personal use into organizational deployments. diff --git a/docs/concepts/dreaming.md b/docs/concepts/dreaming.md index d16c966dad7..e2f1a2ad263 100644 --- a/docs/concepts/dreaming.md +++ b/docs/concepts/dreaming.md @@ -7,8 +7,6 @@ read_when: - You want to tune consolidation without polluting MEMORY.md --- -# Dreaming - Dreaming is the background memory consolidation system in `memory-core`. It helps OpenClaw move strong short-term signals into durable memory while keeping the process explainable and reviewable. diff --git a/docs/concepts/experimental-features.md b/docs/concepts/experimental-features.md index 013902b26f1..73969493ef0 100644 --- a/docs/concepts/experimental-features.md +++ b/docs/concepts/experimental-features.md @@ -7,8 +7,6 @@ read_when: - You want one place to find the currently documented experimental flags --- -# Experimental features - Experimental features in OpenClaw are **opt-in preview surfaces**. They are behind explicit flags because they still need real-world mileage before they deserve a stable default or a long-lived public contract. diff --git a/docs/concepts/features.md b/docs/concepts/features.md index 6304037c92e..0d464abe7ce 100644 --- a/docs/concepts/features.md +++ b/docs/concepts/features.md @@ -5,8 +5,6 @@ read_when: title: "Features" --- -# Features - ## Highlights diff --git a/docs/concepts/markdown-formatting.md b/docs/concepts/markdown-formatting.md index 2aa1fc198b8..f6df87da24e 100644 --- a/docs/concepts/markdown-formatting.md +++ b/docs/concepts/markdown-formatting.md @@ -7,8 +7,6 @@ read_when: title: "Markdown Formatting" --- -# Markdown formatting - OpenClaw formats outbound Markdown by converting it into a shared intermediate representation (IR) before rendering channel-specific output. The IR keeps the source text intact while carrying style/link spans so chunking and rendering can diff --git a/docs/concepts/memory-builtin.md b/docs/concepts/memory-builtin.md index 7b6436d9ac9..4d466e17900 100644 --- a/docs/concepts/memory-builtin.md +++ b/docs/concepts/memory-builtin.md @@ -6,8 +6,6 @@ read_when: - You want to configure embedding providers or hybrid search --- -# Builtin Memory Engine - The builtin engine is the default memory backend. It stores your memory index in a per-agent SQLite database and needs no extra dependencies to get started. diff --git a/docs/concepts/memory-honcho.md b/docs/concepts/memory-honcho.md index a8335893923..38686c7fdad 100644 --- a/docs/concepts/memory-honcho.md +++ b/docs/concepts/memory-honcho.md @@ -6,8 +6,6 @@ read_when: - You want AI-powered recall and user modeling --- -# Honcho Memory - [Honcho](https://honcho.dev) adds AI-native memory to OpenClaw. It persists conversations to a dedicated service and builds user and agent models over time, giving your agent cross-session context that goes beyond workspace Markdown diff --git a/docs/concepts/memory-qmd.md b/docs/concepts/memory-qmd.md index 6c6624b334b..0569f5756c7 100644 --- a/docs/concepts/memory-qmd.md +++ b/docs/concepts/memory-qmd.md @@ -6,8 +6,6 @@ read_when: - You want advanced memory features like reranking or extra indexed paths --- -# QMD Memory Engine - [QMD](https://github.com/tobi/qmd) is a local-first search sidecar that runs alongside OpenClaw. It combines BM25, vector search, and reranking in a single binary, and can index content beyond your workspace memory files. diff --git a/docs/concepts/memory-search.md b/docs/concepts/memory-search.md index ff444e6cbd8..c8a2fc9a430 100644 --- a/docs/concepts/memory-search.md +++ b/docs/concepts/memory-search.md @@ -7,8 +7,6 @@ read_when: - You want to tune search quality --- -# Memory Search - `memory_search` finds relevant notes from your memory files, even when the wording differs from the original text. It works by indexing memory into small chunks and searching them using embeddings, keywords, or both. diff --git a/docs/concepts/memory.md b/docs/concepts/memory.md index 423583a092b..44dfae0b7f7 100644 --- a/docs/concepts/memory.md +++ b/docs/concepts/memory.md @@ -6,8 +6,6 @@ read_when: - You want to know what memory files to write --- -# Memory Overview - OpenClaw remembers things by writing **plain Markdown files** in your agent's workspace. The model only "remembers" what gets saved to disk -- there is no hidden state. diff --git a/docs/concepts/messages.md b/docs/concepts/messages.md index 932a71fe335..293de2096ca 100644 --- a/docs/concepts/messages.md +++ b/docs/concepts/messages.md @@ -7,8 +7,6 @@ read_when: title: "Messages" --- -# Messages - This page ties together how OpenClaw handles inbound messages, sessions, queueing, streaming, and reasoning visibility. diff --git a/docs/concepts/model-failover.md b/docs/concepts/model-failover.md index cbe45413520..d430e2b0541 100644 --- a/docs/concepts/model-failover.md +++ b/docs/concepts/model-failover.md @@ -7,8 +7,6 @@ read_when: title: "Model Failover" --- -# Model failover - OpenClaw handles failures in two stages: 1. **Auth profile rotation** within the current provider. diff --git a/docs/concepts/model-providers.md b/docs/concepts/model-providers.md index 9fc9025d25c..13e8e6715c2 100644 --- a/docs/concepts/model-providers.md +++ b/docs/concepts/model-providers.md @@ -6,8 +6,6 @@ read_when: title: "Model providers" --- -# Model providers - This page covers **LLM/model providers** (not chat channels like WhatsApp/Telegram). For model selection rules, see [/concepts/models](/concepts/models). diff --git a/docs/concepts/models.md b/docs/concepts/models.md index 5aef6f3b3e1..75ec5d37924 100644 --- a/docs/concepts/models.md +++ b/docs/concepts/models.md @@ -7,8 +7,6 @@ read_when: title: "Models CLI" --- -# Models CLI - See [/concepts/model-failover](/concepts/model-failover) for auth profile rotation, cooldowns, and how that interacts with fallbacks. Quick provider overview + examples: [/concepts/model-providers](/concepts/model-providers). diff --git a/docs/concepts/multi-agent.md b/docs/concepts/multi-agent.md index 05d66b578b4..deb4fc947cd 100644 --- a/docs/concepts/multi-agent.md +++ b/docs/concepts/multi-agent.md @@ -5,8 +5,6 @@ read_when: "You want multiple isolated agents (workspaces + auth) in one gateway status: active --- -# Multi-Agent Routing - Goal: multiple _isolated_ agents (separate workspace + `agentDir` + sessions), plus multiple channel accounts (e.g. two WhatsApps) in one running Gateway. Inbound is routed to an agent via bindings. ## What is "one agent"? diff --git a/docs/concepts/oauth.md b/docs/concepts/oauth.md index a72d9389adb..17bb084ed52 100644 --- a/docs/concepts/oauth.md +++ b/docs/concepts/oauth.md @@ -8,8 +8,6 @@ read_when: title: "OAuth" --- -# OAuth - OpenClaw supports “subscription auth” via OAuth for providers that offer it (notably **OpenAI Codex (ChatGPT OAuth)**). For Anthropic, the practical split is now: diff --git a/docs/concepts/presence.md b/docs/concepts/presence.md index 1c9a7e3a12a..3f175e7f54a 100644 --- a/docs/concepts/presence.md +++ b/docs/concepts/presence.md @@ -7,8 +7,6 @@ read_when: title: "Presence" --- -# Presence - OpenClaw “presence” is a lightweight, best‑effort view of: - the **Gateway** itself, and diff --git a/docs/concepts/qa-e2e-automation.md b/docs/concepts/qa-e2e-automation.md index f7bbd36d323..697345344b2 100644 --- a/docs/concepts/qa-e2e-automation.md +++ b/docs/concepts/qa-e2e-automation.md @@ -7,8 +7,6 @@ read_when: title: "QA E2E Automation" --- -# QA E2E Automation - The private QA stack is meant to exercise OpenClaw in a more realistic, channel-shaped way than a single unit test can. diff --git a/docs/concepts/retry.md b/docs/concepts/retry.md index dd03e980085..f70212a6e68 100644 --- a/docs/concepts/retry.md +++ b/docs/concepts/retry.md @@ -6,8 +6,6 @@ read_when: title: "Retry Policy" --- -# Retry policy - ## Goals - Retry per HTTP request, not per multi-step flow. diff --git a/docs/concepts/session-pruning.md b/docs/concepts/session-pruning.md index e918bae0097..9237cf5d902 100644 --- a/docs/concepts/session-pruning.md +++ b/docs/concepts/session-pruning.md @@ -6,8 +6,6 @@ read_when: - You want to understand Anthropic prompt cache optimization --- -# Session Pruning - Session pruning trims **old tool results** from the context before each LLM call. It reduces context bloat from accumulated tool outputs (exec results, file reads, search results) without rewriting normal conversation text. diff --git a/docs/concepts/session-tool.md b/docs/concepts/session-tool.md index e39e34976f5..6366c94eef1 100644 --- a/docs/concepts/session-tool.md +++ b/docs/concepts/session-tool.md @@ -7,8 +7,6 @@ read_when: title: "Session Tools" --- -# Session Tools - OpenClaw gives agents tools to work across sessions, inspect status, and orchestrate sub-agents. diff --git a/docs/concepts/session.md b/docs/concepts/session.md index d05010fcb2b..592311ab497 100644 --- a/docs/concepts/session.md +++ b/docs/concepts/session.md @@ -6,8 +6,6 @@ read_when: title: "Session Management" --- -# Session Management - OpenClaw organizes conversations into **sessions**. Each message is routed to a session based on where it came from -- DMs, group chats, cron jobs, etc. diff --git a/docs/concepts/soul.md b/docs/concepts/soul.md index 1064cb47ebe..a0ac85fe0cc 100644 --- a/docs/concepts/soul.md +++ b/docs/concepts/soul.md @@ -7,8 +7,6 @@ read_when: title: "SOUL.md Personality Guide" --- -# SOUL.md Personality Guide - `SOUL.md` is where your agent's voice lives. OpenClaw injects it on normal sessions, so it has real weight. If your agent diff --git a/docs/concepts/system-prompt.md b/docs/concepts/system-prompt.md index 18497037b06..dc386a1909f 100644 --- a/docs/concepts/system-prompt.md +++ b/docs/concepts/system-prompt.md @@ -6,8 +6,6 @@ read_when: title: "System Prompt" --- -# System Prompt - OpenClaw builds a custom system prompt for every agent run. The prompt is **OpenClaw-owned** and does not use the pi-coding-agent default prompt. The prompt is assembled by OpenClaw and injected into each agent run. diff --git a/docs/concepts/timezone.md b/docs/concepts/timezone.md index 36465ffb2f1..de319431528 100644 --- a/docs/concepts/timezone.md +++ b/docs/concepts/timezone.md @@ -6,8 +6,6 @@ read_when: title: "Timezones" --- -# Timezones - OpenClaw standardizes timestamps so the model sees a **single reference time**. ## Message envelopes (local by default) diff --git a/docs/concepts/typing-indicators.md b/docs/concepts/typing-indicators.md index f41982d2a48..18ab3ef7494 100644 --- a/docs/concepts/typing-indicators.md +++ b/docs/concepts/typing-indicators.md @@ -5,8 +5,6 @@ read_when: title: "Typing Indicators" --- -# Typing indicators - Typing indicators are sent to the chat channel while a run is active. Use `agents.defaults.typingMode` to control **when** typing starts and `typingIntervalSeconds` to control **how often** it refreshes. diff --git a/docs/concepts/usage-tracking.md b/docs/concepts/usage-tracking.md index 947e854632d..c41c9ccbcb4 100644 --- a/docs/concepts/usage-tracking.md +++ b/docs/concepts/usage-tracking.md @@ -6,8 +6,6 @@ read_when: title: "Usage Tracking" --- -# Usage tracking - ## What it is - Pulls provider usage/quota directly from their usage endpoints. diff --git a/docs/diagnostics/flags.md b/docs/diagnostics/flags.md index 2fcfdaaa658..c98829306c4 100644 --- a/docs/diagnostics/flags.md +++ b/docs/diagnostics/flags.md @@ -6,8 +6,6 @@ read_when: title: "Diagnostics Flags" --- -# Diagnostics Flags - Diagnostics flags let you enable targeted debug logs without turning on verbose logging everywhere. Flags are opt-in and have no effect unless a subsystem checks them. ## How it works diff --git a/docs/gateway/configuration-examples.md b/docs/gateway/configuration-examples.md index 357c3e0ee60..ef94c3fb242 100644 --- a/docs/gateway/configuration-examples.md +++ b/docs/gateway/configuration-examples.md @@ -7,8 +7,6 @@ read_when: title: "Configuration Examples" --- -# Configuration Examples - Examples below are aligned with the current config schema. For the exhaustive reference and per-field notes, see [Configuration](/gateway/configuration). ## Quick start diff --git a/docs/gateway/configuration-reference.md b/docs/gateway/configuration-reference.md index a89cc00010c..c6054bc5cca 100644 --- a/docs/gateway/configuration-reference.md +++ b/docs/gateway/configuration-reference.md @@ -6,8 +6,6 @@ read_when: - You are validating channel, model, gateway, or tool config blocks --- -# Configuration Reference - Core config reference for `~/.openclaw/openclaw.json`. For a task-oriented overview, see [Configuration](/gateway/configuration). This page covers the main OpenClaw config surfaces and links out when a subsystem has its own deeper reference. It does **not** try to inline every channel/plugin-owned command catalog or every deep memory/QMD knob on one page. diff --git a/docs/gateway/configuration.md b/docs/gateway/configuration.md index a29ebf9e8a0..fd8df811910 100644 --- a/docs/gateway/configuration.md +++ b/docs/gateway/configuration.md @@ -7,8 +7,6 @@ read_when: title: "Configuration" --- -# Configuration - OpenClaw reads an optional **JSON5** config from `~/.openclaw/openclaw.json`. The active config path must be a regular file. Symlinked `openclaw.json` layouts are unsupported for OpenClaw-owned writes; an atomic write may replace diff --git a/docs/gateway/diagnostics.md b/docs/gateway/diagnostics.md index 02cd3aa56e4..ccd31a6c24e 100644 --- a/docs/gateway/diagnostics.md +++ b/docs/gateway/diagnostics.md @@ -7,8 +7,6 @@ read_when: - Reviewing what diagnostics data is recorded or redacted --- -# Diagnostics Export - OpenClaw can create a local diagnostics zip that is safe to attach to bug reports. It combines sanitized Gateway status, health, logs, config shape, and recent payload-free stability events. diff --git a/docs/gateway/doctor.md b/docs/gateway/doctor.md index eb714d157d8..ba518317555 100644 --- a/docs/gateway/doctor.md +++ b/docs/gateway/doctor.md @@ -6,8 +6,6 @@ read_when: title: "Doctor" --- -# Doctor - `openclaw doctor` is the repair + migration tool for OpenClaw. It fixes stale config/state, checks health, and provides actionable repair steps. diff --git a/docs/gateway/gateway-lock.md b/docs/gateway/gateway-lock.md index 0ebeaf7b1bf..f85a5729e64 100644 --- a/docs/gateway/gateway-lock.md +++ b/docs/gateway/gateway-lock.md @@ -6,8 +6,6 @@ read_when: title: "Gateway Lock" --- -# Gateway lock - ## Why - Ensure only one gateway instance runs per base port on the same host; additional gateways must use isolated profiles and unique ports. diff --git a/docs/gateway/index.md b/docs/gateway/index.md index 41749036f02..6d4b2db80c5 100644 --- a/docs/gateway/index.md +++ b/docs/gateway/index.md @@ -2,11 +2,9 @@ summary: "Runbook for the Gateway service, lifecycle, and operations" read_when: - Running or debugging the gateway process -title: "Gateway Runbook" +title: "Gateway runbook" --- -# Gateway runbook - Use this page for day-1 startup and day-2 operations of the Gateway service. diff --git a/docs/gateway/local-models.md b/docs/gateway/local-models.md index 3074406eae6..6c426f550ef 100644 --- a/docs/gateway/local-models.md +++ b/docs/gateway/local-models.md @@ -7,8 +7,6 @@ read_when: title: "Local Models" --- -# Local models - Local is doable, but OpenClaw expects large context + strong defenses against prompt injection. Small cards truncate context and leak safety. Aim high: **≥2 maxed-out Mac Studios or equivalent GPU rig (~$30k+)**. A single **24 GB** GPU works only for lighter prompts with higher latency. Use the **largest / full-size model variant you can run**; aggressively quantized or “small” checkpoints raise prompt-injection risk (see [Security](/gateway/security)). If you want the lowest-friction local setup, start with [LM Studio](/providers/lmstudio) or [Ollama](/providers/ollama) and `openclaw onboard`. This page is the opinionated guide for higher-end local stacks and custom OpenAI-compatible local servers. diff --git a/docs/gateway/network-model.md b/docs/gateway/network-model.md index d255f80009b..775fb293631 100644 --- a/docs/gateway/network-model.md +++ b/docs/gateway/network-model.md @@ -5,8 +5,6 @@ read_when: title: "Network model" --- -# Network Model - > This content has been merged into [Network](/network#core-model). See that page for the current guide. Most operations flow through the Gateway (`openclaw gateway`), a single long-running diff --git a/docs/gateway/openshell.md b/docs/gateway/openshell.md index 833eb03d7f4..6935595511e 100644 --- a/docs/gateway/openshell.md +++ b/docs/gateway/openshell.md @@ -7,8 +7,6 @@ read_when: - You need to choose between mirror and remote workspace modes --- -# OpenShell - OpenShell is a managed sandbox backend for OpenClaw. Instead of running Docker containers locally, OpenClaw delegates sandbox lifecycle to the `openshell` CLI, which provisions remote environments with SSH-based command execution. diff --git a/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md b/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md index db6b1079e41..02e691a37a5 100644 --- a/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +++ b/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md @@ -5,8 +5,6 @@ read_when: "You hit 'sandbox jail' or see a tool/elevated refusal and want the e status: active --- -# Sandbox vs Tool Policy vs Elevated - OpenClaw has three related (but different) controls: 1. **Sandbox** (`agents.defaults.sandbox.*` / `agents.list[].sandbox.*`) decides **where tools run** (sandbox backend vs host). diff --git a/docs/gateway/sandboxing.md b/docs/gateway/sandboxing.md index 5656ccc3f7b..7ffa7e423da 100644 --- a/docs/gateway/sandboxing.md +++ b/docs/gateway/sandboxing.md @@ -5,8 +5,6 @@ read_when: "You want a dedicated explanation of sandboxing or need to tune agent status: active --- -# Sandboxing - OpenClaw can run **tools inside sandbox backends** to reduce blast radius. This is **optional** and controlled by configuration (`agents.defaults.sandbox` or `agents.list[].sandbox`). If sandboxing is off, tools run on the host. diff --git a/docs/gateway/secrets-plan-contract.md b/docs/gateway/secrets-plan-contract.md index b27518bdb1e..03ee805e587 100644 --- a/docs/gateway/secrets-plan-contract.md +++ b/docs/gateway/secrets-plan-contract.md @@ -7,8 +7,6 @@ read_when: title: "Secrets Apply Plan Contract" --- -# Secrets apply plan contract - This page defines the strict contract enforced by `openclaw secrets apply`. If a target does not match these rules, apply fails before mutating configuration. diff --git a/docs/gateway/secrets.md b/docs/gateway/secrets.md index f3eed7eca57..db6221503a9 100644 --- a/docs/gateway/secrets.md +++ b/docs/gateway/secrets.md @@ -7,8 +7,6 @@ read_when: title: "Secrets Management" --- -# Secrets management - OpenClaw supports additive SecretRefs so supported credentials do not need to be stored as plaintext in configuration. Plaintext still works. SecretRefs are opt-in per credential. diff --git a/docs/gateway/security/audit-checks.md b/docs/gateway/security/audit-checks.md index 8e9857fdda1..c0c95f3acfb 100644 --- a/docs/gateway/security/audit-checks.md +++ b/docs/gateway/security/audit-checks.md @@ -7,8 +7,6 @@ read_when: title: "Security audit checks" --- -# Security audit checks - `openclaw security audit` emits structured findings keyed by `checkId`. This page is the reference catalog for those IDs. For the high-level threat model and hardening guidance, see [Security](/gateway/security). diff --git a/docs/gateway/trusted-proxy-auth.md b/docs/gateway/trusted-proxy-auth.md index e0a63c5d06d..f2fa3545294 100644 --- a/docs/gateway/trusted-proxy-auth.md +++ b/docs/gateway/trusted-proxy-auth.md @@ -8,8 +8,6 @@ read_when: - Deciding where to set HSTS and other HTTP hardening headers --- -# Trusted Proxy Auth - > ⚠️ **Security-sensitive feature.** This mode delegates authentication entirely to your reverse proxy. Misconfiguration can expose your Gateway to unauthorized access. Read this page carefully before enabling. ## When to Use diff --git a/docs/help/debugging.md b/docs/help/debugging.md index 38e842aea0a..630eb20efc2 100644 --- a/docs/help/debugging.md +++ b/docs/help/debugging.md @@ -7,8 +7,6 @@ read_when: title: "Debugging" --- -# Debugging - This page covers debugging helpers for streaming output, especially when a provider mixes reasoning into normal text. diff --git a/docs/help/environment.md b/docs/help/environment.md index 66578b5ce89..2254e3df23e 100644 --- a/docs/help/environment.md +++ b/docs/help/environment.md @@ -7,8 +7,6 @@ read_when: title: "Environment Variables" --- -# Environment variables - OpenClaw pulls environment variables from multiple sources. The rule is **never override existing values**. ## Precedence (highest → lowest) diff --git a/docs/help/faq.md b/docs/help/faq.md index c11388d7afc..3129b41381e 100644 --- a/docs/help/faq.md +++ b/docs/help/faq.md @@ -6,8 +6,6 @@ read_when: title: "FAQ" --- -# FAQ - Quick answers plus deeper troubleshooting for real-world setups (local dev, VPS, multi-agent, OAuth/API keys, model failover). For runtime diagnostics, see [Troubleshooting](/gateway/troubleshooting). For the full config reference, see [Configuration](/gateway/configuration). ## First 60 seconds if something is broken diff --git a/docs/help/gpt54-codex-agentic-parity-maintainers.md b/docs/help/gpt54-codex-agentic-parity-maintainers.md index 30fc634632f..cd5a10d8dbb 100644 --- a/docs/help/gpt54-codex-agentic-parity-maintainers.md +++ b/docs/help/gpt54-codex-agentic-parity-maintainers.md @@ -6,8 +6,6 @@ read_when: - Maintaining the six-contract agentic architecture behind the parity program --- -# GPT-5.4 / Codex Parity Maintainer Notes - This note explains how to review the GPT-5.4 / Codex parity program as four merge units without losing the original six-contract architecture. ## Merge units diff --git a/docs/help/index.md b/docs/help/index.md index 26b990c1533..ce13cac31c5 100644 --- a/docs/help/index.md +++ b/docs/help/index.md @@ -6,8 +6,6 @@ read_when: title: "Help" --- -# Help - If you want a quick “get unstuck” flow, start here: - **Troubleshooting:** [Start here](/help/troubleshooting) diff --git a/docs/help/scripts.md b/docs/help/scripts.md index 2828574b7d2..5a31b2cf8ab 100644 --- a/docs/help/scripts.md +++ b/docs/help/scripts.md @@ -6,8 +6,6 @@ read_when: title: "Scripts" --- -# Scripts - The `scripts/` directory contains helper scripts for local workflows and ops tasks. Use these when a task is clearly tied to a script; otherwise prefer the CLI. diff --git a/docs/install/bun.md b/docs/install/bun.md index d0e11d5b166..573209a7222 100644 --- a/docs/install/bun.md +++ b/docs/install/bun.md @@ -6,8 +6,6 @@ read_when: title: "Bun (Experimental)" --- -# Bun (Experimental) - Bun is **not recommended for gateway runtime** (known issues with WhatsApp and Telegram). Use Node for production. diff --git a/docs/install/clawdock.md b/docs/install/clawdock.md index 66523deaab0..2c7bdc99354 100644 --- a/docs/install/clawdock.md +++ b/docs/install/clawdock.md @@ -6,8 +6,6 @@ read_when: title: "ClawDock" --- -# ClawDock - ClawDock is a small shell-helper layer for Docker-based OpenClaw installs. It gives you short commands like `clawdock-start`, `clawdock-dashboard`, and `clawdock-fix-token` instead of longer `docker compose ...` invocations. diff --git a/docs/install/digitalocean.md b/docs/install/digitalocean.md index 92b2efc1e2d..1a26bed8f04 100644 --- a/docs/install/digitalocean.md +++ b/docs/install/digitalocean.md @@ -6,8 +6,6 @@ read_when: title: "DigitalOcean" --- -# DigitalOcean - Run a persistent OpenClaw Gateway on a DigitalOcean Droplet. ## Prerequisites diff --git a/docs/install/docker-vm-runtime.md b/docs/install/docker-vm-runtime.md index 0b4a1501e26..03f9823c722 100644 --- a/docs/install/docker-vm-runtime.md +++ b/docs/install/docker-vm-runtime.md @@ -6,8 +6,6 @@ read_when: title: "Docker VM Runtime" --- -# Docker VM Runtime - Shared runtime steps for VM-based Docker installs such as GCP, Hetzner, and similar VPS providers. ## Bake required binaries into the image diff --git a/docs/install/exe-dev.md b/docs/install/exe-dev.md index 394198cbf47..e86502a73ab 100644 --- a/docs/install/exe-dev.md +++ b/docs/install/exe-dev.md @@ -6,8 +6,6 @@ read_when: title: "exe.dev" --- -# exe.dev - Goal: OpenClaw Gateway running on an exe.dev VM, reachable from your laptop via: `https://.exe.xyz` This page assumes exe.dev's default **exeuntu** image. If you picked a different distro, map packages accordingly. diff --git a/docs/install/hostinger.md b/docs/install/hostinger.md index 7beff21c9e6..fdf2db46145 100644 --- a/docs/install/hostinger.md +++ b/docs/install/hostinger.md @@ -7,8 +7,6 @@ read_when: title: "Hostinger" --- -# Hostinger - Run a persistent OpenClaw Gateway on [Hostinger](https://www.hostinger.com/openclaw) via a **1-Click** managed deployment or a **VPS** install. ## Prerequisites diff --git a/docs/install/index.md b/docs/install/index.md index de201c6520d..5bc3e15581f 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -7,8 +7,6 @@ read_when: title: "Install" --- -# Install - ## Recommended: installer script The fastest way to install. It detects your OS, installs Node if needed, installs OpenClaw, and launches onboarding. diff --git a/docs/install/installer.md b/docs/install/installer.md index f7277e6345f..5aa5d8250c8 100644 --- a/docs/install/installer.md +++ b/docs/install/installer.md @@ -7,8 +7,6 @@ read_when: title: "Installer Internals" --- -# Installer internals - OpenClaw ships three installer scripts, served from `openclaw.ai`. | Script | Platform | What it does | diff --git a/docs/install/migrating-matrix.md b/docs/install/migrating-matrix.md index 662cd68864c..cc31a6ce424 100644 --- a/docs/install/migrating-matrix.md +++ b/docs/install/migrating-matrix.md @@ -6,8 +6,6 @@ read_when: title: "Matrix migration" --- -# Matrix migration - This page covers upgrades from the previous public `matrix` plugin to the current implementation. For most users, the upgrade is in place: diff --git a/docs/install/node.md b/docs/install/node.md index 940eaa195d4..de559bc0921 100644 --- a/docs/install/node.md +++ b/docs/install/node.md @@ -7,8 +7,6 @@ read_when: - "npm install -g fails with permissions or PATH issues" --- -# Node.js - OpenClaw requires **Node 22.14 or newer**. **Node 24 is the default and recommended runtime** for installs, CI, and release workflows. Node 22 remains supported via the active LTS line. The [installer script](/install#alternative-install-methods) will detect and install Node automatically — this page is for when you want to set up Node yourself and make sure everything is wired up correctly (versions, PATH, global installs). ## Check your version diff --git a/docs/install/oracle.md b/docs/install/oracle.md index e994a4fccb0..58dce4804f1 100644 --- a/docs/install/oracle.md +++ b/docs/install/oracle.md @@ -7,8 +7,6 @@ read_when: title: "Oracle Cloud" --- -# Oracle Cloud - Run a persistent OpenClaw Gateway on Oracle Cloud's **Always Free** ARM tier (up to 4 OCPU, 24 GB RAM, 200 GB storage) at no cost. ## Prerequisites diff --git a/docs/install/podman.md b/docs/install/podman.md index f2ee029a782..012ad787b96 100644 --- a/docs/install/podman.md +++ b/docs/install/podman.md @@ -5,8 +5,6 @@ read_when: title: "Podman" --- -# Podman - Run the OpenClaw Gateway in a rootless Podman container, managed by your current non-root user. The intended model is: diff --git a/docs/install/raspberry-pi.md b/docs/install/raspberry-pi.md index 045dc65ab34..4ee2b522dc0 100644 --- a/docs/install/raspberry-pi.md +++ b/docs/install/raspberry-pi.md @@ -7,8 +7,6 @@ read_when: title: "Raspberry Pi" --- -# Raspberry Pi - Run a persistent, always-on OpenClaw Gateway on a Raspberry Pi. Since the Pi is just the gateway (models run in the cloud via API), even a modest Pi handles the workload well. ## Prerequisites diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index 09c5587579b..e919478d22d 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -6,8 +6,6 @@ read_when: title: "Uninstall" --- -# Uninstall - Two paths: - **Easy path** if `openclaw` is still installed. diff --git a/docs/install/updating.md b/docs/install/updating.md index ce34bb2937c..ecfc99b0bb6 100644 --- a/docs/install/updating.md +++ b/docs/install/updating.md @@ -6,8 +6,6 @@ read_when: title: "Updating" --- -# Updating - Keep OpenClaw up to date. ## Recommended: `openclaw update` diff --git a/docs/nodes/index.md b/docs/nodes/index.md index 9819c3944c3..1ffbc7b9787 100644 --- a/docs/nodes/index.md +++ b/docs/nodes/index.md @@ -7,8 +7,6 @@ read_when: title: "Nodes" --- -# Nodes - A **node** is a companion device (macOS/iOS/Android/headless) that connects to the Gateway **WebSocket** (same port as operators) with `role: "node"` and exposes a command surface (e.g. `canvas.*`, `camera.*`, `device.*`, `notifications.*`, `system.*`) via `node.invoke`. Protocol details: [Gateway protocol](/gateway/protocol). Legacy transport: [Bridge protocol](/gateway/bridge-protocol) (TCP JSONL; diff --git a/docs/nodes/talk.md b/docs/nodes/talk.md index 37fd69f065e..a97c9abf333 100644 --- a/docs/nodes/talk.md +++ b/docs/nodes/talk.md @@ -6,8 +6,6 @@ read_when: title: "Talk Mode" --- -# Talk Mode - Talk mode is a continuous voice conversation loop: 1. Listen for speech diff --git a/docs/nodes/troubleshooting.md b/docs/nodes/troubleshooting.md index e6a47ae5c9d..0f691523dfe 100644 --- a/docs/nodes/troubleshooting.md +++ b/docs/nodes/troubleshooting.md @@ -6,8 +6,6 @@ read_when: title: "Node Troubleshooting" --- -# Node troubleshooting - Use this page when a node is visible in status but node tools fail. ## Command ladder diff --git a/docs/pi-dev.md b/docs/pi-dev.md index f259879eb8d..8291dc0a11b 100644 --- a/docs/pi-dev.md +++ b/docs/pi-dev.md @@ -6,8 +6,6 @@ read_when: - Running Pi-specific lint, typecheck, and live test flows --- -# Pi Development Workflow - This guide summarizes a sane workflow for working on the pi integration in OpenClaw. ## Type Checking and Linting diff --git a/docs/pi.md b/docs/pi.md index daa2709d181..1a1e0fae227 100644 --- a/docs/pi.md +++ b/docs/pi.md @@ -6,8 +6,6 @@ read_when: - Modifying agent session lifecycle, tooling, or provider wiring for Pi --- -# Pi Integration Architecture - This document describes how OpenClaw integrates with [pi-coding-agent](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent) and its sibling packages (`pi-ai`, `pi-agent-core`, `pi-tui`) to power its AI agent capabilities. ## Overview diff --git a/docs/plan/ui-channels.md b/docs/plan/ui-channels.md index 85effa3db2c..bee48cf386f 100644 --- a/docs/plan/ui-channels.md +++ b/docs/plan/ui-channels.md @@ -7,8 +7,6 @@ read_when: - Debugging Discord Carbon import fanout or channel plugin runtime laziness --- -# Channel Presentation Refactor Plan - ## Status Implemented for the shared agent, CLI, plugin capability, and outbound delivery surfaces: diff --git a/docs/platforms/index.md b/docs/platforms/index.md index 34c28e4c62b..6840e9159f0 100644 --- a/docs/platforms/index.md +++ b/docs/platforms/index.md @@ -6,8 +6,6 @@ read_when: title: "Platforms" --- -# Platforms - OpenClaw core is written in TypeScript. **Node is the recommended runtime**. Bun is not recommended for the Gateway (WhatsApp/Telegram bugs). diff --git a/docs/platforms/linux.md b/docs/platforms/linux.md index cbc9a9255b3..0ccdfdf4992 100644 --- a/docs/platforms/linux.md +++ b/docs/platforms/linux.md @@ -7,8 +7,6 @@ read_when: title: "Linux App" --- -# Linux App - The Gateway is fully supported on Linux. **Node is the recommended runtime**. Bun is not recommended for the Gateway (WhatsApp/Telegram bugs). diff --git a/docs/platforms/mac/skills.md b/docs/platforms/mac/skills.md index 8472ebb68c7..0f68539a120 100644 --- a/docs/platforms/mac/skills.md +++ b/docs/platforms/mac/skills.md @@ -6,8 +6,6 @@ read_when: title: "Skills (macOS)" --- -# Skills (macOS) - The macOS app surfaces OpenClaw skills via the gateway; it does not parse skills locally. ## Data source diff --git a/docs/platforms/mac/webchat.md b/docs/platforms/mac/webchat.md index 65f76e05e44..995ef8a07e4 100644 --- a/docs/platforms/mac/webchat.md +++ b/docs/platforms/mac/webchat.md @@ -5,8 +5,6 @@ read_when: title: "WebChat (macOS)" --- -# WebChat (macOS app) - The macOS menu bar app embeds the WebChat UI as a native SwiftUI view. It connects to the Gateway and defaults to the **main session** for the selected agent (with a session switcher for other sessions). diff --git a/docs/platforms/macos.md b/docs/platforms/macos.md index 14971b36117..a4e3ed4772d 100644 --- a/docs/platforms/macos.md +++ b/docs/platforms/macos.md @@ -6,8 +6,6 @@ read_when: title: "macOS App" --- -# OpenClaw macOS Companion (menu bar + gateway broker) - The macOS app is the **menu‑bar companion** for OpenClaw. It owns permissions, manages/attaches to the Gateway locally (launchd or manual), and exposes macOS capabilities to the agent as a node. diff --git a/docs/platforms/windows.md b/docs/platforms/windows.md index d25185c5dd7..3a10fabfdff 100644 --- a/docs/platforms/windows.md +++ b/docs/platforms/windows.md @@ -7,8 +7,6 @@ read_when: title: "Windows" --- -# Windows - OpenClaw supports both **native Windows** and **WSL2**. WSL2 is the more stable path and recommended for the full experience — the CLI, Gateway, and tooling run inside Linux with full compatibility. Native Windows works for diff --git a/docs/plugins/building-extensions.md b/docs/plugins/building-extensions.md index c0dc81267cf..f442d4371c0 100644 --- a/docs/plugins/building-extensions.md +++ b/docs/plugins/building-extensions.md @@ -5,6 +5,4 @@ read_when: - Legacy link to building-extensions --- -# Building Plugins - This page has moved to [Building Plugins](/plugins/building-plugins). diff --git a/docs/plugins/building-plugins.md b/docs/plugins/building-plugins.md index bf0929b3d61..ecd3995c5f7 100644 --- a/docs/plugins/building-plugins.md +++ b/docs/plugins/building-plugins.md @@ -8,8 +8,6 @@ read_when: - You are adding a new channel, provider, tool, or other capability to OpenClaw --- -# Building Plugins - Plugins extend OpenClaw with new capabilities: channels, model providers, speech, realtime transcription, realtime voice, media understanding, image generation, video generation, web fetch, web search, agent tools, or any diff --git a/docs/plugins/bundles.md b/docs/plugins/bundles.md index 15bb323d9fb..19ddbb0857c 100644 --- a/docs/plugins/bundles.md +++ b/docs/plugins/bundles.md @@ -7,8 +7,6 @@ read_when: title: "Plugin Bundles" --- -# Plugin Bundles - OpenClaw can install plugins from three external ecosystems: **Codex**, **Claude**, and **Cursor**. These are called **bundles** — content and metadata packs that OpenClaw maps into native features like skills, hooks, and MCP tools. diff --git a/docs/plugins/codex-harness.md b/docs/plugins/codex-harness.md index ed5c1bb37aa..e5a30b6e268 100644 --- a/docs/plugins/codex-harness.md +++ b/docs/plugins/codex-harness.md @@ -7,8 +7,6 @@ read_when: - You want to disable PI fallback for Codex-only deployments --- -# Codex Harness - The bundled `codex` plugin lets OpenClaw run embedded agent turns through the Codex app-server instead of the built-in PI harness. diff --git a/docs/plugins/community.md b/docs/plugins/community.md index a0239bd7ca5..c13c6982f20 100644 --- a/docs/plugins/community.md +++ b/docs/plugins/community.md @@ -6,8 +6,6 @@ read_when: title: "Community Plugins" --- -# Community Plugins - Community plugins are third-party packages that extend OpenClaw with new channels, tools, providers, or other capabilities. They are built and maintained by the community, published on [ClawHub](/tools/clawhub) or npm, and diff --git a/docs/plugins/memory-wiki.md b/docs/plugins/memory-wiki.md index 363ebedab4f..19c795eccfc 100644 --- a/docs/plugins/memory-wiki.md +++ b/docs/plugins/memory-wiki.md @@ -7,8 +7,6 @@ read_when: title: "Memory Wiki" --- -# Memory Wiki - `memory-wiki` is a bundled plugin that turns durable memory into a compiled knowledge vault. diff --git a/docs/plugins/message-presentation.md b/docs/plugins/message-presentation.md index 5924134c0b0..e09d69b14ac 100644 --- a/docs/plugins/message-presentation.md +++ b/docs/plugins/message-presentation.md @@ -8,8 +8,6 @@ read_when: - Debugging provider-specific card/block/component rendering regressions --- -# Message Presentation - Message presentation is OpenClaw's shared contract for rich outbound chat UI. It lets agents, CLI commands, approval flows, and plugins describe the message intent once, while each channel plugin renders the best native shape it can. diff --git a/docs/plugins/sdk-agent-harness.md b/docs/plugins/sdk-agent-harness.md index bf772d551f2..ff864b5391a 100644 --- a/docs/plugins/sdk-agent-harness.md +++ b/docs/plugins/sdk-agent-harness.md @@ -8,8 +8,6 @@ read_when: - You need to understand how the Codex plugin relates to model providers --- -# Agent Harness Plugins - An **agent harness** is the low level executor for one prepared OpenClaw agent turn. It is not a model provider, not a channel, and not a tool registry. diff --git a/docs/plugins/sdk-channel-plugins.md b/docs/plugins/sdk-channel-plugins.md index 39c07293500..d8c25e9c9b5 100644 --- a/docs/plugins/sdk-channel-plugins.md +++ b/docs/plugins/sdk-channel-plugins.md @@ -8,8 +8,6 @@ read_when: - You need to understand the ChannelPlugin adapter surface --- -# Building Channel Plugins - This guide walks through building a channel plugin that connects OpenClaw to a messaging platform. By the end you will have a working channel with DM security, pairing, reply threading, and outbound messaging. diff --git a/docs/plugins/sdk-entrypoints.md b/docs/plugins/sdk-entrypoints.md index b8ff2d6b017..10e5aa83b88 100644 --- a/docs/plugins/sdk-entrypoints.md +++ b/docs/plugins/sdk-entrypoints.md @@ -8,8 +8,6 @@ read_when: - You are looking up entry point options --- -# Plugin Entry Points - Every plugin exports a default entry object. The SDK provides three helpers for creating them. diff --git a/docs/plugins/sdk-migration.md b/docs/plugins/sdk-migration.md index fdb6f4b24e8..60f7c14d13c 100644 --- a/docs/plugins/sdk-migration.md +++ b/docs/plugins/sdk-migration.md @@ -9,8 +9,6 @@ read_when: - You maintain an external OpenClaw plugin --- -# Plugin SDK Migration - OpenClaw has moved from a broad backwards-compatibility layer to a modern plugin architecture with focused, documented imports. If your plugin was built before the new architecture, this guide helps you migrate. diff --git a/docs/plugins/sdk-provider-plugins.md b/docs/plugins/sdk-provider-plugins.md index e5afb82fe50..a15be311d11 100644 --- a/docs/plugins/sdk-provider-plugins.md +++ b/docs/plugins/sdk-provider-plugins.md @@ -8,8 +8,6 @@ read_when: - You need to understand provider auth, catalogs, and runtime hooks --- -# Building provider plugins - This guide walks through building a provider plugin that adds a model provider (LLM) to OpenClaw. By the end you will have a provider with a model catalog, API key auth, and dynamic model resolution. diff --git a/docs/plugins/sdk-runtime.md b/docs/plugins/sdk-runtime.md index 75056bc9dde..a107458e85a 100644 --- a/docs/plugins/sdk-runtime.md +++ b/docs/plugins/sdk-runtime.md @@ -8,8 +8,6 @@ read_when: - You are accessing config, agent, or media helpers from plugin code --- -# Plugin Runtime Helpers - Reference for the `api.runtime` object injected into every plugin during registration. Use these helpers instead of importing host internals directly. diff --git a/docs/plugins/sdk-setup.md b/docs/plugins/sdk-setup.md index 4921986b57c..a688add4532 100644 --- a/docs/plugins/sdk-setup.md +++ b/docs/plugins/sdk-setup.md @@ -8,8 +8,6 @@ read_when: - You are defining plugin config schemas or package.json openclaw metadata --- -# Plugin Setup and Config - Reference for plugin packaging (`package.json` metadata), manifests (`openclaw.plugin.json`), setup entries, and config schemas. diff --git a/docs/plugins/sdk-testing.md b/docs/plugins/sdk-testing.md index dbb1dbdfe9f..60c83c9c7b7 100644 --- a/docs/plugins/sdk-testing.md +++ b/docs/plugins/sdk-testing.md @@ -8,8 +8,6 @@ read_when: - You want to understand contract tests for bundled plugins --- -# Plugin Testing - Reference for test utilities, patterns, and lint enforcement for OpenClaw plugins. diff --git a/docs/plugins/skill-workshop.md b/docs/plugins/skill-workshop.md index 32c47c0940f..d190ea333ff 100644 --- a/docs/plugins/skill-workshop.md +++ b/docs/plugins/skill-workshop.md @@ -8,8 +8,6 @@ read_when: - You are deciding whether to enable automatic skill creation --- -# Skill Workshop plugin - Skill Workshop is **experimental**. It is disabled by default, its capture heuristics and reviewer prompts may change between releases, and automatic writes should be used only in trusted workspaces after reviewing pending-mode diff --git a/docs/prose.md b/docs/prose.md index 45e4995c938..ad83f6b8794 100644 --- a/docs/prose.md +++ b/docs/prose.md @@ -7,8 +7,6 @@ read_when: title: "OpenProse" --- -# OpenProse - OpenProse is a portable, markdown-first workflow format for orchestrating AI sessions. In OpenClaw it ships as a plugin that installs an OpenProse skill pack plus a `/prose` slash command. Programs live in `.prose` files and can spawn multiple sub-agents with explicit control flow. Official site: [https://www.prose.md](https://www.prose.md) diff --git a/docs/providers/alibaba.md b/docs/providers/alibaba.md index 2496f1f3ae9..aa8f3137524 100644 --- a/docs/providers/alibaba.md +++ b/docs/providers/alibaba.md @@ -6,8 +6,6 @@ read_when: - You need Model Studio or DashScope API key setup for video generation --- -# Alibaba Model Studio - OpenClaw ships a bundled `alibaba` video-generation provider for Wan models on Alibaba Model Studio / DashScope. diff --git a/docs/providers/arcee.md b/docs/providers/arcee.md index a7fdee17582..2d9e4512d6b 100644 --- a/docs/providers/arcee.md +++ b/docs/providers/arcee.md @@ -6,8 +6,6 @@ read_when: - You need the API key env var or CLI auth choice --- -# Arcee AI - [Arcee AI](https://arcee.ai) provides access to the Trinity family of mixture-of-experts models through an OpenAI-compatible API. All Trinity models are Apache 2.0 licensed. Arcee AI models can be accessed directly via the Arcee platform or through [OpenRouter](/providers/openrouter). diff --git a/docs/providers/bedrock-mantle.md b/docs/providers/bedrock-mantle.md index 9416e25bd10..e125b56993a 100644 --- a/docs/providers/bedrock-mantle.md +++ b/docs/providers/bedrock-mantle.md @@ -6,8 +6,6 @@ read_when: title: "Amazon Bedrock Mantle" --- -# Amazon Bedrock Mantle - OpenClaw includes a bundled **Amazon Bedrock Mantle** provider that connects to the Mantle OpenAI-compatible endpoint. Mantle hosts open-source and third-party models (GPT-OSS, Qwen, Kimi, GLM, and similar) through a standard diff --git a/docs/providers/bedrock.md b/docs/providers/bedrock.md index 914bf8bfb2a..1f989de274e 100644 --- a/docs/providers/bedrock.md +++ b/docs/providers/bedrock.md @@ -6,8 +6,6 @@ read_when: title: "Amazon Bedrock" --- -# Amazon Bedrock - OpenClaw can use **Amazon Bedrock** models via pi-ai's **Bedrock Converse** streaming provider. Bedrock auth uses the **AWS SDK default credential chain**, not an API key. diff --git a/docs/providers/chutes.md b/docs/providers/chutes.md index fcc91358cd4..726a59b030f 100644 --- a/docs/providers/chutes.md +++ b/docs/providers/chutes.md @@ -7,8 +7,6 @@ read_when: - You want the default model, aliases, or discovery behavior --- -# Chutes - [Chutes](https://chutes.ai) exposes open-source model catalogs through an OpenAI-compatible API. OpenClaw supports both browser OAuth and direct API-key auth for the bundled `chutes` provider. diff --git a/docs/providers/claude-max-api-proxy.md b/docs/providers/claude-max-api-proxy.md index 8a3d6ed75ba..08e336237d0 100644 --- a/docs/providers/claude-max-api-proxy.md +++ b/docs/providers/claude-max-api-proxy.md @@ -7,8 +7,6 @@ read_when: title: "Claude Max API Proxy" --- -# Claude Max API Proxy - **claude-max-api-proxy** is a community tool that exposes your Claude Max/Pro subscription as an OpenAI-compatible API endpoint. This allows you to use your subscription with any tool that supports the OpenAI API format. diff --git a/docs/providers/cloudflare-ai-gateway.md b/docs/providers/cloudflare-ai-gateway.md index 1d189420514..37bab709cbf 100644 --- a/docs/providers/cloudflare-ai-gateway.md +++ b/docs/providers/cloudflare-ai-gateway.md @@ -6,8 +6,6 @@ read_when: - You need the account ID, gateway ID, or API key env var --- -# Cloudflare AI Gateway - Cloudflare AI Gateway sits in front of provider APIs and lets you add analytics, caching, and controls. For Anthropic, OpenClaw uses the Anthropic Messages API through your Gateway endpoint. | Property | Value | diff --git a/docs/providers/comfy.md b/docs/providers/comfy.md index 769ed1652a6..624b9b25844 100644 --- a/docs/providers/comfy.md +++ b/docs/providers/comfy.md @@ -7,8 +7,6 @@ read_when: - You need the bundled comfy plugin config keys --- -# ComfyUI - OpenClaw ships a bundled `comfy` plugin for workflow-driven ComfyUI runs. The plugin is entirely workflow-driven, so OpenClaw does not try to map generic `size`, `aspectRatio`, `resolution`, `durationSeconds`, or TTS-style controls onto your graph. | Property | Detail | diff --git a/docs/providers/deepseek.md b/docs/providers/deepseek.md index 8889546cfd4..c56bc2f0eb6 100644 --- a/docs/providers/deepseek.md +++ b/docs/providers/deepseek.md @@ -6,8 +6,6 @@ read_when: - You need the API key env var or CLI auth choice --- -# DeepSeek - [DeepSeek](https://www.deepseek.com) provides powerful AI models with an OpenAI-compatible API. | Property | Value | diff --git a/docs/providers/elevenlabs.md b/docs/providers/elevenlabs.md index 29f55c73f70..9b318c8d979 100644 --- a/docs/providers/elevenlabs.md +++ b/docs/providers/elevenlabs.md @@ -7,8 +7,6 @@ read_when: title: "ElevenLabs" --- -# ElevenLabs - OpenClaw uses ElevenLabs for text-to-speech, batch speech-to-text with Scribe v2, and Voice Call streaming STT with Scribe v2 Realtime. diff --git a/docs/providers/fal.md b/docs/providers/fal.md index b726508a71d..da38de8665a 100644 --- a/docs/providers/fal.md +++ b/docs/providers/fal.md @@ -7,8 +7,6 @@ read_when: - You want fal defaults for image_generate or video_generate --- -# fal - OpenClaw ships a bundled `fal` provider for hosted image and video generation. | Property | Value | diff --git a/docs/providers/fireworks.md b/docs/providers/fireworks.md index 8e44e32c917..129b4faf327 100644 --- a/docs/providers/fireworks.md +++ b/docs/providers/fireworks.md @@ -6,8 +6,6 @@ read_when: - You need the Fireworks API key env var or default model id --- -# Fireworks - [Fireworks](https://fireworks.ai) exposes open-weight and routed models through an OpenAI-compatible API. OpenClaw includes a bundled Fireworks provider plugin. | Property | Value | diff --git a/docs/providers/github-copilot.md b/docs/providers/github-copilot.md index b36f546dc18..cb5c353ea63 100644 --- a/docs/providers/github-copilot.md +++ b/docs/providers/github-copilot.md @@ -6,8 +6,6 @@ read_when: title: "GitHub Copilot" --- -# GitHub Copilot - GitHub Copilot is GitHub's AI coding assistant. It provides access to Copilot models for your GitHub account and plan. OpenClaw can use Copilot as a model provider in two different ways. diff --git a/docs/providers/google.md b/docs/providers/google.md index 8e91f596793..fcfc5bab37c 100644 --- a/docs/providers/google.md +++ b/docs/providers/google.md @@ -6,8 +6,6 @@ read_when: - You need the API key or OAuth auth flow --- -# Google (Gemini) - The Google plugin provides access to Gemini models through Google AI Studio, plus image generation, media understanding (image/audio/video), text-to-speech, and web search via Gemini Grounding. diff --git a/docs/providers/groq.md b/docs/providers/groq.md index 5f5b449d99c..a8e6e3a8324 100644 --- a/docs/providers/groq.md +++ b/docs/providers/groq.md @@ -6,8 +6,6 @@ read_when: - You need the API key env var or CLI auth choice --- -# Groq - [Groq](https://groq.com) provides ultra-fast inference on open-source models (Llama, Gemma, Mistral, and more) using custom LPU hardware. OpenClaw connects to Groq through its OpenAI-compatible API. diff --git a/docs/providers/huggingface.md b/docs/providers/huggingface.md index 4fa721f3825..2f95c29cd08 100644 --- a/docs/providers/huggingface.md +++ b/docs/providers/huggingface.md @@ -6,8 +6,6 @@ read_when: title: "Hugging Face (Inference)" --- -# Hugging Face (Inference) - [Hugging Face Inference Providers](https://huggingface.co/docs/inference-providers) offer OpenAI-compatible chat completions through a single router API. You get access to many models (DeepSeek, Llama, and more) with one token. OpenClaw uses the **OpenAI-compatible endpoint** (chat completions only); for text-to-image, embeddings, or speech use the [HF inference clients](https://huggingface.co/docs/api-inference/quicktour) directly. - Provider: `huggingface` diff --git a/docs/providers/inferrs.md b/docs/providers/inferrs.md index 8b843e78547..56bfdd787f6 100644 --- a/docs/providers/inferrs.md +++ b/docs/providers/inferrs.md @@ -7,8 +7,6 @@ read_when: title: "inferrs" --- -# inferrs - [inferrs](https://github.com/ericcurtin/inferrs) can serve local models behind an OpenAI-compatible `/v1` API. OpenClaw works with `inferrs` through the generic `openai-completions` path. diff --git a/docs/providers/litellm.md b/docs/providers/litellm.md index f6bb9087860..bcc3bb09031 100644 --- a/docs/providers/litellm.md +++ b/docs/providers/litellm.md @@ -6,8 +6,6 @@ read_when: - You need cost tracking, logging, or model routing through LiteLLM --- -# LiteLLM - [LiteLLM](https://litellm.ai) is an open-source LLM gateway that provides a unified API to 100+ model providers. Route OpenClaw through LiteLLM to get centralized cost tracking, logging, and the flexibility to switch backends without changing your OpenClaw config. diff --git a/docs/providers/lmstudio.md b/docs/providers/lmstudio.md index cfe1b000994..ae9c5fd88cb 100644 --- a/docs/providers/lmstudio.md +++ b/docs/providers/lmstudio.md @@ -6,8 +6,6 @@ read_when: title: "LM Studio" --- -# LM Studio - LM Studio is a friendly yet powerful app for running open-weight models on your own hardware. It lets you run llama.cpp (GGUF) or MLX models (Apple Silicon). Comes in a GUI package or headless daemon (`llmster`). For product and setup docs, see [lmstudio.ai](https://lmstudio.ai/). ## Quick start diff --git a/docs/providers/minimax.md b/docs/providers/minimax.md index 22698fc6d87..17592347c24 100644 --- a/docs/providers/minimax.md +++ b/docs/providers/minimax.md @@ -6,8 +6,6 @@ read_when: title: "MiniMax" --- -# MiniMax - OpenClaw's MiniMax provider defaults to **MiniMax M2.7**. MiniMax also provides: diff --git a/docs/providers/mistral.md b/docs/providers/mistral.md index 7eb537be1ca..50384fd5c51 100644 --- a/docs/providers/mistral.md +++ b/docs/providers/mistral.md @@ -7,8 +7,6 @@ read_when: title: "Mistral" --- -# Mistral - OpenClaw supports Mistral for both text/image model routing (`mistral/...`) and audio transcription via Voxtral in media understanding. Mistral can also be used for memory embeddings (`memorySearch.provider = "mistral"`). diff --git a/docs/providers/nvidia.md b/docs/providers/nvidia.md index 042d9610938..3cf7c1e4798 100644 --- a/docs/providers/nvidia.md +++ b/docs/providers/nvidia.md @@ -6,8 +6,6 @@ read_when: title: "NVIDIA" --- -# NVIDIA - NVIDIA provides an OpenAI-compatible API at `https://integrate.api.nvidia.com/v1` for open models for free. Authenticate with an API key from [build.nvidia.com](https://build.nvidia.com/settings/api-keys). diff --git a/docs/providers/ollama.md b/docs/providers/ollama.md index ab3f6d35b57..e511ba546e9 100644 --- a/docs/providers/ollama.md +++ b/docs/providers/ollama.md @@ -7,8 +7,6 @@ read_when: title: "Ollama" --- -# Ollama - OpenClaw integrates with Ollama's native API (`/api/chat`) for hosted cloud models and local/self-hosted Ollama servers. You can use Ollama in three modes: `Cloud + Local` through a reachable Ollama host, `Cloud only` against `https://ollama.com`, or `Local only` against a reachable Ollama host. diff --git a/docs/providers/openai.md b/docs/providers/openai.md index aab7b462292..41d8c428211 100644 --- a/docs/providers/openai.md +++ b/docs/providers/openai.md @@ -7,8 +7,6 @@ read_when: title: "OpenAI" --- -# OpenAI - OpenAI provides developer APIs for GPT models. OpenClaw supports two auth routes behind the same canonical OpenAI model refs: - **API key** — direct OpenAI Platform access with usage-based billing (`openai/*` models) diff --git a/docs/providers/opencode-go.md b/docs/providers/opencode-go.md index c68c0512d98..d13df374c5f 100644 --- a/docs/providers/opencode-go.md +++ b/docs/providers/opencode-go.md @@ -6,8 +6,6 @@ read_when: title: "OpenCode Go" --- -# OpenCode Go - OpenCode Go is the Go catalog within [OpenCode](/providers/opencode). It uses the same `OPENCODE_API_KEY` as the Zen catalog, but keeps the runtime provider id `opencode-go` so upstream per-model routing stays correct. diff --git a/docs/providers/opencode.md b/docs/providers/opencode.md index e7960001aa6..fa63b8e95de 100644 --- a/docs/providers/opencode.md +++ b/docs/providers/opencode.md @@ -6,8 +6,6 @@ read_when: title: "OpenCode" --- -# OpenCode - OpenCode exposes two hosted catalogs in OpenClaw: | Catalog | Prefix | Runtime provider | diff --git a/docs/providers/openrouter.md b/docs/providers/openrouter.md index 8e6234ff407..9136a357408 100644 --- a/docs/providers/openrouter.md +++ b/docs/providers/openrouter.md @@ -6,8 +6,6 @@ read_when: title: "OpenRouter" --- -# OpenRouter - OpenRouter provides a **unified API** that routes requests to many models behind a single endpoint and API key. It is OpenAI-compatible, so most OpenAI SDKs work by switching the base URL. diff --git a/docs/providers/qianfan.md b/docs/providers/qianfan.md index bf00d7fc668..cc77fc85b47 100644 --- a/docs/providers/qianfan.md +++ b/docs/providers/qianfan.md @@ -6,8 +6,6 @@ read_when: title: "Qianfan" --- -# Qianfan - Qianfan is Baidu's MaaS platform, providing a **unified API** that routes requests to many models behind a single endpoint and API key. It is OpenAI-compatible, so most OpenAI SDKs work by switching the base URL. diff --git a/docs/providers/qwen.md b/docs/providers/qwen.md index 5464a4d4143..bcb22945143 100644 --- a/docs/providers/qwen.md +++ b/docs/providers/qwen.md @@ -6,8 +6,6 @@ read_when: title: "Qwen" --- -# Qwen - **Qwen OAuth has been removed.** The free-tier OAuth integration diff --git a/docs/providers/qwen_modelstudio.md b/docs/providers/qwen_modelstudio.md index 721a0a51c9c..e1a4156885d 100644 --- a/docs/providers/qwen_modelstudio.md +++ b/docs/providers/qwen_modelstudio.md @@ -6,8 +6,6 @@ read_when: - You want the canonical Qwen provider page --- -# Qwen / Model Studio - This page moved to [Qwen](/providers/qwen). See [Qwen](/providers/qwen) for the canonical provider setup, endpoint details, compatibility aliases, and Wan video-generation notes. diff --git a/docs/providers/runway.md b/docs/providers/runway.md index 0cb7ad28039..3189dd47543 100644 --- a/docs/providers/runway.md +++ b/docs/providers/runway.md @@ -7,8 +7,6 @@ read_when: - You want to make Runway the default video provider --- -# Runway - OpenClaw ships a bundled `runway` provider for hosted video generation. | Property | Value | diff --git a/docs/providers/sglang.md b/docs/providers/sglang.md index 6aa57d8c93b..8080873b68f 100644 --- a/docs/providers/sglang.md +++ b/docs/providers/sglang.md @@ -6,8 +6,6 @@ read_when: title: "SGLang" --- -# SGLang - SGLang can serve open-source models via an **OpenAI-compatible** HTTP API. OpenClaw can connect to SGLang using the `openai-completions` API. diff --git a/docs/providers/stepfun.md b/docs/providers/stepfun.md index 89b092ca875..fcdb963439e 100644 --- a/docs/providers/stepfun.md +++ b/docs/providers/stepfun.md @@ -6,8 +6,6 @@ read_when: title: "StepFun" --- -# StepFun - OpenClaw includes a bundled StepFun provider plugin with two provider ids: - `stepfun` for the standard endpoint diff --git a/docs/providers/synthetic.md b/docs/providers/synthetic.md index 140fb6c658a..ed7b33167ea 100644 --- a/docs/providers/synthetic.md +++ b/docs/providers/synthetic.md @@ -6,8 +6,6 @@ read_when: title: "Synthetic" --- -# Synthetic - [Synthetic](https://synthetic.new) exposes Anthropic-compatible endpoints. OpenClaw registers it as the `synthetic` provider and uses the Anthropic Messages API. diff --git a/docs/providers/together.md b/docs/providers/together.md index 01a5e778e46..ea3505cb029 100644 --- a/docs/providers/together.md +++ b/docs/providers/together.md @@ -6,8 +6,6 @@ read_when: - You need the API key env var or CLI auth choice --- -# Together AI - [Together AI](https://together.ai) provides access to leading open-source models including Llama, DeepSeek, Kimi, and more through a unified API. diff --git a/docs/providers/venice.md b/docs/providers/venice.md index fbb47fe2f3b..886ddf4ee0a 100644 --- a/docs/providers/venice.md +++ b/docs/providers/venice.md @@ -6,8 +6,6 @@ read_when: title: "Venice AI" --- -# Venice AI - Venice AI provides **privacy-focused AI inference** with support for uncensored models and access to major proprietary models through their anonymized proxy. All inference is private by default — no training on your data, no logging. ## Why Venice in OpenClaw diff --git a/docs/providers/vercel-ai-gateway.md b/docs/providers/vercel-ai-gateway.md index 34ba9f78843..8bf2051288f 100644 --- a/docs/providers/vercel-ai-gateway.md +++ b/docs/providers/vercel-ai-gateway.md @@ -6,8 +6,6 @@ read_when: - You need the API key env var or CLI auth choice --- -# Vercel AI Gateway - The [Vercel AI Gateway](https://vercel.com/ai-gateway) provides a unified API to access hundreds of models through a single endpoint. diff --git a/docs/providers/vllm.md b/docs/providers/vllm.md index 3c2358ca8c5..949eade18f9 100644 --- a/docs/providers/vllm.md +++ b/docs/providers/vllm.md @@ -6,8 +6,6 @@ read_when: title: "vLLM" --- -# vLLM - vLLM can serve open-source (and some custom) models via an **OpenAI-compatible** HTTP API. OpenClaw connects to vLLM using the `openai-completions` API. OpenClaw can also **auto-discover** available models from vLLM when you opt in with `VLLM_API_KEY` (any value works if your server does not enforce auth) and you do not define an explicit `models.providers.vllm` entry. diff --git a/docs/providers/volcengine.md b/docs/providers/volcengine.md index 16d8782de63..0f80c902b0e 100644 --- a/docs/providers/volcengine.md +++ b/docs/providers/volcengine.md @@ -6,8 +6,6 @@ read_when: - You need the Volcengine API key setup --- -# Volcengine (Doubao) - The Volcengine provider gives access to Doubao models and third-party models hosted on Volcano Engine, with separate endpoints for general and coding workloads. diff --git a/docs/providers/vydra.md b/docs/providers/vydra.md index 06dcfe01142..3a1b43d4d33 100644 --- a/docs/providers/vydra.md +++ b/docs/providers/vydra.md @@ -6,8 +6,6 @@ read_when: title: "Vydra" --- -# Vydra - The bundled Vydra plugin adds: - Image generation via `vydra/grok-imagine` diff --git a/docs/providers/xai.md b/docs/providers/xai.md index e056233ddb6..535b552f607 100644 --- a/docs/providers/xai.md +++ b/docs/providers/xai.md @@ -6,8 +6,6 @@ read_when: title: "xAI" --- -# xAI - OpenClaw ships a bundled `xai` provider plugin for Grok models. ## Getting started diff --git a/docs/providers/xiaomi.md b/docs/providers/xiaomi.md index 3c098728bef..85e4a30956d 100644 --- a/docs/providers/xiaomi.md +++ b/docs/providers/xiaomi.md @@ -6,8 +6,6 @@ read_when: title: "Xiaomi MiMo" --- -# Xiaomi MiMo - Xiaomi MiMo is the API platform for **MiMo** models. OpenClaw uses the Xiaomi OpenAI-compatible endpoint with API-key authentication. diff --git a/docs/providers/zai.md b/docs/providers/zai.md index a2bf89ea689..0b7f228df13 100644 --- a/docs/providers/zai.md +++ b/docs/providers/zai.md @@ -6,8 +6,6 @@ read_when: title: "Z.AI" --- -# Z.AI - Z.AI is the API platform for **GLM** models. It provides REST APIs for GLM and uses API keys for authentication. Create your API key in the Z.AI console. OpenClaw uses the `zai` provider with a Z.AI API key. diff --git a/docs/refactor/async-exec-duplicate-completion-investigation.md b/docs/refactor/async-exec-duplicate-completion-investigation.md index 2c108cf1a05..6ffff5de5aa 100644 --- a/docs/refactor/async-exec-duplicate-completion-investigation.md +++ b/docs/refactor/async-exec-duplicate-completion-investigation.md @@ -6,8 +6,6 @@ read_when: title: "Async Exec Duplicate Completion Investigation" --- -# Async Exec Duplicate Completion Investigation - ## Scope - Session: `agent:main:telegram:group:-1003774691294:topic:1` diff --git a/docs/refactor/qa.md b/docs/refactor/qa.md index a25ef3a4f82..75ec9b5d05d 100644 --- a/docs/refactor/qa.md +++ b/docs/refactor/qa.md @@ -6,8 +6,6 @@ read_when: title: "QA Refactor" --- -# QA Refactor - Status: foundational migration landed. ## Goal diff --git a/docs/reference/RELEASING.md b/docs/reference/RELEASING.md index d0d044cc2b6..55d74923423 100644 --- a/docs/reference/RELEASING.md +++ b/docs/reference/RELEASING.md @@ -6,8 +6,6 @@ read_when: - Looking for version naming and cadence --- -# Release Policy - OpenClaw has three public release lanes: - stable: tagged releases that publish to npm `beta` by default, or to npm `latest` when explicitly requested diff --git a/docs/reference/memory-config.md b/docs/reference/memory-config.md index 527521aea59..3eba6167923 100644 --- a/docs/reference/memory-config.md +++ b/docs/reference/memory-config.md @@ -8,8 +8,6 @@ read_when: - You want to enable multimodal memory indexing --- -# Memory configuration reference - This page lists every configuration knob for OpenClaw memory search. For conceptual overviews, see: diff --git a/docs/reference/prompt-caching.md b/docs/reference/prompt-caching.md index 55a9f5e2195..f7c0f3650d5 100644 --- a/docs/reference/prompt-caching.md +++ b/docs/reference/prompt-caching.md @@ -7,8 +7,6 @@ read_when: - You are tuning heartbeat and cache-ttl pruning together --- -# Prompt caching - Prompt caching means the model provider can reuse unchanged prompt prefixes (usually system/developer instructions and other stable context) across turns instead of re-processing them every time. OpenClaw normalizes provider usage into `cacheRead` and `cacheWrite` where the upstream API exposes those counters directly. Status surfaces can also recover cache counters from the most recent transcript diff --git a/docs/reference/rich-output-protocol.md b/docs/reference/rich-output-protocol.md index 665f5b9a9d6..732d34149ae 100644 --- a/docs/reference/rich-output-protocol.md +++ b/docs/reference/rich-output-protocol.md @@ -6,8 +6,6 @@ read_when: title: "Rich Output Protocol" --- -# Rich Output Protocol - Assistant output can carry a small set of delivery/render directives: - `MEDIA:` for attachment delivery diff --git a/docs/reference/rpc.md b/docs/reference/rpc.md index ff79bc855a8..01d79c1264b 100644 --- a/docs/reference/rpc.md +++ b/docs/reference/rpc.md @@ -6,8 +6,6 @@ read_when: title: "RPC Adapters" --- -# RPC adapters - OpenClaw integrates external CLIs via JSON-RPC. Two patterns are used today. ## Pattern A: HTTP daemon (signal-cli) diff --git a/docs/reference/secretref-credential-surface.md b/docs/reference/secretref-credential-surface.md index 26bc1d1aa28..c5bcabdaff2 100644 --- a/docs/reference/secretref-credential-surface.md +++ b/docs/reference/secretref-credential-surface.md @@ -7,8 +7,6 @@ read_when: title: "SecretRef Credential Surface" --- -# SecretRef credential surface - This page defines the canonical SecretRef credential surface. Scope intent: diff --git a/docs/reference/templates/HEARTBEAT.md b/docs/reference/templates/HEARTBEAT.md index bd4720e166f..a37aff15dfd 100644 --- a/docs/reference/templates/HEARTBEAT.md +++ b/docs/reference/templates/HEARTBEAT.md @@ -5,8 +5,6 @@ read_when: - Bootstrapping a workspace manually --- -# HEARTBEAT.md Template - ```markdown # Keep this file empty (or with only comments) to skip heartbeat API calls. diff --git a/docs/reference/test.md b/docs/reference/test.md index 112043702c7..8a10f69d6ac 100644 --- a/docs/reference/test.md +++ b/docs/reference/test.md @@ -5,8 +5,6 @@ read_when: title: "Tests" --- -# Tests - - Full testing kit (suites, live, Docker): [Testing](/help/testing) - `pnpm test:force`: Kills any lingering gateway process holding the default control port, then runs the full Vitest suite with an isolated gateway port so server tests don’t collide with a running instance. Use this when a prior gateway run left port 18789 occupied. diff --git a/docs/reference/wizard.md b/docs/reference/wizard.md index df04485b4a4..795111f3383 100644 --- a/docs/reference/wizard.md +++ b/docs/reference/wizard.md @@ -8,8 +8,6 @@ title: "Onboarding Reference" sidebarTitle: "Onboarding Reference" --- -# Onboarding Reference - This is the full reference for `openclaw onboard`. For a high-level overview, see [Onboarding (CLI)](/start/wizard). diff --git a/docs/security/formal-verification.md b/docs/security/formal-verification.md index b0b789c2e3d..649ccc79f18 100644 --- a/docs/security/formal-verification.md +++ b/docs/security/formal-verification.md @@ -7,8 +7,6 @@ read_when: permalink: /security/formal-verification/ --- -# Formal Verification (Security Models) - This page tracks OpenClaw’s **formal security models** (TLA+/TLC today; more as needed). > Note: some older links may refer to the previous project name. diff --git a/docs/start/bootstrapping.md b/docs/start/bootstrapping.md index e3a2849359c..137c69192a1 100644 --- a/docs/start/bootstrapping.md +++ b/docs/start/bootstrapping.md @@ -8,8 +8,6 @@ title: "Agent Bootstrapping" sidebarTitle: "Bootstrapping" --- -# Agent Bootstrapping - Bootstrapping is the **first‑run** ritual that prepares an agent workspace and collects identity details. It happens after onboarding, when the agent starts for the first time. diff --git a/docs/start/docs-directory.md b/docs/start/docs-directory.md index 351603cc021..346901ccdcc 100644 --- a/docs/start/docs-directory.md +++ b/docs/start/docs-directory.md @@ -5,8 +5,6 @@ read_when: title: "Docs directory" --- -# Docs Directory - This page is a curated index. If you are new, start with [Getting Started](/start/getting-started). For a complete map of the docs, see [Docs hubs](/start/hubs). diff --git a/docs/start/getting-started.md b/docs/start/getting-started.md index 321de2179af..0111294d3d1 100644 --- a/docs/start/getting-started.md +++ b/docs/start/getting-started.md @@ -6,8 +6,6 @@ read_when: title: "Getting Started" --- -# Getting Started - Install OpenClaw, run onboarding, and chat with your AI assistant — all in about 5 minutes. By the end you will have a running Gateway, configured auth, and a working chat session. diff --git a/docs/start/hubs.md b/docs/start/hubs.md index 1dc18f00c74..f674c6950ad 100644 --- a/docs/start/hubs.md +++ b/docs/start/hubs.md @@ -5,8 +5,6 @@ read_when: title: "Docs Hubs" --- -# Docs hubs - If you are new to OpenClaw, start with [Getting Started](/start/getting-started). diff --git a/docs/start/onboarding-overview.md b/docs/start/onboarding-overview.md index 7d7e4c7fd60..c57750d6115 100644 --- a/docs/start/onboarding-overview.md +++ b/docs/start/onboarding-overview.md @@ -7,8 +7,6 @@ title: "Onboarding Overview" sidebarTitle: "Onboarding Overview" --- -# Onboarding Overview - OpenClaw has two onboarding paths. Both configure auth, the Gateway, and optional chat channels — they just differ in how you interact with the setup. diff --git a/docs/start/onboarding.md b/docs/start/onboarding.md index 22a85b1b49f..411385cb7ef 100644 --- a/docs/start/onboarding.md +++ b/docs/start/onboarding.md @@ -7,8 +7,6 @@ title: "Onboarding (macOS App)" sidebarTitle: "Onboarding: macOS App" --- -# Onboarding (macOS App) - This doc describes the **current** first‑run setup flow. The goal is a smooth “day 0” experience: pick where the Gateway runs, connect auth, run the wizard, and let the agent bootstrap itself. diff --git a/docs/start/quickstart.md b/docs/start/quickstart.md index f4b96893fe6..b0d29603c87 100644 --- a/docs/start/quickstart.md +++ b/docs/start/quickstart.md @@ -6,8 +6,6 @@ read_when: title: "Quick start" --- -# Quick start - Quick start is now part of [Getting Started](/start/getting-started). diff --git a/docs/start/setup.md b/docs/start/setup.md index facd78c4339..513f4ff1e4c 100644 --- a/docs/start/setup.md +++ b/docs/start/setup.md @@ -6,8 +6,6 @@ read_when: title: "Setup" --- -# Setup - If you are setting up for the first time, start with [Getting Started](/start/getting-started). For onboarding details, see [Onboarding (CLI)](/start/wizard). diff --git a/docs/start/showcase.md b/docs/start/showcase.md index 8a05e646388..a39eec63300 100644 --- a/docs/start/showcase.md +++ b/docs/start/showcase.md @@ -7,8 +7,6 @@ read_when: - Updating community project highlights --- -# Showcase - OpenClaw projects are not toy demos. People are shipping PR review loops, mobile apps, home automation, voice systems, devtools, and memory-heavy workflows from the channels they already use — chat-native builds on Telegram, WhatsApp, Discord, and terminals; real automation for booking, shopping, and support without waiting for an API; and physical-world integrations with printers, vacuums, cameras, and home systems. diff --git a/docs/start/wizard-cli-automation.md b/docs/start/wizard-cli-automation.md index dc5807c2c47..264d2afe257 100644 --- a/docs/start/wizard-cli-automation.md +++ b/docs/start/wizard-cli-automation.md @@ -7,8 +7,6 @@ title: "CLI Automation" sidebarTitle: "CLI automation" --- -# CLI Automation - Use `--non-interactive` to automate `openclaw onboard`. diff --git a/docs/start/wizard-cli-reference.md b/docs/start/wizard-cli-reference.md index 953bf8b8734..49d38bd0f82 100644 --- a/docs/start/wizard-cli-reference.md +++ b/docs/start/wizard-cli-reference.md @@ -7,8 +7,6 @@ title: "CLI Setup Reference" sidebarTitle: "CLI reference" --- -# CLI Setup Reference - This page is the full reference for `openclaw onboard`. For the short guide, see [Onboarding (CLI)](/start/wizard). diff --git a/docs/start/wizard.md b/docs/start/wizard.md index b321ac91cb3..2e65ce4f85b 100644 --- a/docs/start/wizard.md +++ b/docs/start/wizard.md @@ -7,8 +7,6 @@ title: "Onboarding (CLI)" sidebarTitle: "Onboarding: CLI" --- -# Onboarding (CLI) - CLI onboarding is the **recommended** way to set up OpenClaw on macOS, Linux, or Windows (via WSL2; strongly recommended). It configures a local Gateway or a remote Gateway connection, plus channels, skills, diff --git a/docs/tools/acp-agents.md b/docs/tools/acp-agents.md index 206f0f2d4ca..a30dcbe8511 100644 --- a/docs/tools/acp-agents.md +++ b/docs/tools/acp-agents.md @@ -10,8 +10,6 @@ read_when: title: "ACP agents" --- -# ACP agents - [Agent Client Protocol (ACP)](https://agentclientprotocol.com/) sessions let OpenClaw run external coding harnesses (for example Pi, Claude Code, Codex, Cursor, Copilot, OpenClaw ACP, OpenCode, Gemini CLI, and other supported ACPX harnesses) through an ACP backend plugin. If you ask OpenClaw in plain language to "run this in Codex" or "start Claude Code in a thread", OpenClaw should route that request to the ACP runtime (not the native sub-agent runtime). Each ACP session spawn is tracked as a [background task](/automation/tasks). diff --git a/docs/tools/agent-send.md b/docs/tools/agent-send.md index a78ac75f067..70a43bb97c6 100644 --- a/docs/tools/agent-send.md +++ b/docs/tools/agent-send.md @@ -6,8 +6,6 @@ read_when: title: "Agent Send" --- -# Agent Send - `openclaw agent` runs a single agent turn from the command line without needing an inbound chat message. Use it for scripted workflows, testing, and programmatic delivery. diff --git a/docs/tools/apply-patch.md b/docs/tools/apply-patch.md index 97b3e93f419..18a43c487d5 100644 --- a/docs/tools/apply-patch.md +++ b/docs/tools/apply-patch.md @@ -6,8 +6,6 @@ read_when: title: "apply_patch Tool" --- -# apply_patch tool - Apply file changes using a structured patch format. This is ideal for multi-file or multi-hunk edits where a single `edit` call would be brittle. diff --git a/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md b/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md index 695e35ca177..3069351fa45 100644 --- a/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +++ b/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md @@ -7,8 +7,6 @@ read_when: title: "WSL2 + Windows + remote Chrome CDP troubleshooting" --- -# WSL2 + Windows + remote Chrome CDP troubleshooting - This guide covers the common split-host setup where: - OpenClaw Gateway runs inside WSL2 diff --git a/docs/tools/browser.md b/docs/tools/browser.md index d6827bf3d95..b49ddf51af6 100644 --- a/docs/tools/browser.md +++ b/docs/tools/browser.md @@ -7,8 +7,6 @@ read_when: title: "Browser (OpenClaw-managed)" --- -# Browser (openclaw-managed) - OpenClaw can run a **dedicated Chrome/Brave/Edge/Chromium profile** that the agent controls. It is isolated from your personal browser and is managed through a small local control service inside the Gateway (loopback only). diff --git a/docs/tools/btw.md b/docs/tools/btw.md index 38a30fcec77..031d9b354f0 100644 --- a/docs/tools/btw.md +++ b/docs/tools/btw.md @@ -6,8 +6,6 @@ read_when: title: "BTW Side Questions" --- -# BTW Side Questions - `/btw` lets you ask a quick side question about the **current session** without turning that question into normal conversation history. diff --git a/docs/tools/capability-cookbook.md b/docs/tools/capability-cookbook.md index 5df1ba3e6cd..a8f934cf802 100644 --- a/docs/tools/capability-cookbook.md +++ b/docs/tools/capability-cookbook.md @@ -8,8 +8,6 @@ title: "Adding Capabilities (Contributor Guide)" sidebarTitle: "Adding Capabilities" --- -# Adding Capabilities - This is a **contributor guide** for OpenClaw core developers. If you are building an external plugin, see [Building Plugins](/plugins/building-plugins) diff --git a/docs/tools/clawhub.md b/docs/tools/clawhub.md index ef6f7478e66..968b7502ff5 100644 --- a/docs/tools/clawhub.md +++ b/docs/tools/clawhub.md @@ -7,8 +7,6 @@ read_when: title: "ClawHub" --- -# ClawHub - ClawHub is the public registry for **OpenClaw skills and plugins**. - Use native `openclaw` commands to search/install/update skills and install diff --git a/docs/tools/code-execution.md b/docs/tools/code-execution.md index 1e64319dee0..f9e338002e4 100644 --- a/docs/tools/code-execution.md +++ b/docs/tools/code-execution.md @@ -7,8 +7,6 @@ read_when: title: "Code Execution" --- -# Code Execution - `code_execution` runs sandboxed remote Python analysis on xAI's Responses API. This is different from local [`exec`](/tools/exec): diff --git a/docs/tools/creating-skills.md b/docs/tools/creating-skills.md index 4697ce626ce..6c5fb64efcf 100644 --- a/docs/tools/creating-skills.md +++ b/docs/tools/creating-skills.md @@ -6,8 +6,6 @@ read_when: - You need a quick starter workflow for SKILL.md-based skills --- -# Creating Skills - Skills teach the agent how and when to use tools. Each skill is a directory containing a `SKILL.md` file with YAML frontmatter and markdown instructions. diff --git a/docs/tools/diffs.md b/docs/tools/diffs.md index 291fb33af69..7d25072b8ab 100644 --- a/docs/tools/diffs.md +++ b/docs/tools/diffs.md @@ -7,8 +7,6 @@ read_when: - You need controlled, temporary diff artifacts with secure defaults --- -# Diffs - `diffs` is an optional plugin tool with short built-in system guidance and a companion skill that turns change content into a read-only diff artifact for agents. It accepts either: diff --git a/docs/tools/duckduckgo-search.md b/docs/tools/duckduckgo-search.md index 5016caa3fda..61f8e831de1 100644 --- a/docs/tools/duckduckgo-search.md +++ b/docs/tools/duckduckgo-search.md @@ -7,8 +7,6 @@ read_when: title: "DuckDuckGo Search" --- -# DuckDuckGo Search - OpenClaw supports DuckDuckGo as a **key-free** `web_search` provider. No API key or account is required. diff --git a/docs/tools/elevated.md b/docs/tools/elevated.md index 3206c28373a..b956e489c65 100644 --- a/docs/tools/elevated.md +++ b/docs/tools/elevated.md @@ -6,8 +6,6 @@ read_when: title: "Elevated Mode" --- -# Elevated Mode - When an agent runs inside a sandbox, its `exec` commands are confined to the sandbox environment. **Elevated mode** lets the agent break out and run commands outside the sandbox instead, with configurable approval gates. diff --git a/docs/tools/exa-search.md b/docs/tools/exa-search.md index 7864a2a31c9..4aaa93fb480 100644 --- a/docs/tools/exa-search.md +++ b/docs/tools/exa-search.md @@ -7,8 +7,6 @@ read_when: title: "Exa Search" --- -# Exa Search - OpenClaw supports [Exa AI](https://exa.ai/) as a `web_search` provider. Exa offers neural, keyword, and hybrid search modes with built-in content extraction (highlights, text, summaries). diff --git a/docs/tools/exec-approvals.md b/docs/tools/exec-approvals.md index b3809bfa262..8bd9909f3e9 100644 --- a/docs/tools/exec-approvals.md +++ b/docs/tools/exec-approvals.md @@ -7,8 +7,6 @@ read_when: title: "Exec approvals" --- -# Exec approvals - Exec approvals are the **companion app / node host guardrail** for letting a sandboxed agent run commands on a real host (`gateway` or `node`). A safety interlock: commands are allowed only when policy + allowlist + (optional) user diff --git a/docs/tools/exec.md b/docs/tools/exec.md index af64dae5b8f..c523637ab52 100644 --- a/docs/tools/exec.md +++ b/docs/tools/exec.md @@ -6,8 +6,6 @@ read_when: title: "Exec Tool" --- -# Exec tool - Run shell commands in the workspace. Supports foreground + background execution via `process`. If `process` is disallowed, `exec` runs synchronously and ignores `yieldMs`/`background`. Background sessions are scoped per agent; `process` only sees sessions from the same agent. diff --git a/docs/tools/firecrawl.md b/docs/tools/firecrawl.md index 040600c1f70..dc960eaccc6 100644 --- a/docs/tools/firecrawl.md +++ b/docs/tools/firecrawl.md @@ -8,8 +8,6 @@ read_when: title: "Firecrawl" --- -# Firecrawl - OpenClaw can use **Firecrawl** in three ways: - as the `web_search` provider diff --git a/docs/tools/gemini-search.md b/docs/tools/gemini-search.md index eeb150a516b..b07b34c62d1 100644 --- a/docs/tools/gemini-search.md +++ b/docs/tools/gemini-search.md @@ -7,8 +7,6 @@ read_when: title: "Gemini Search" --- -# Gemini Search - OpenClaw supports Gemini models with built-in [Google Search grounding](https://ai.google.dev/gemini-api/docs/grounding), which returns AI-synthesized answers backed by live Google Search results with diff --git a/docs/tools/grok-search.md b/docs/tools/grok-search.md index b759ed2afb6..8e290beab64 100644 --- a/docs/tools/grok-search.md +++ b/docs/tools/grok-search.md @@ -6,8 +6,6 @@ read_when: title: "Grok Search" --- -# Grok Search - OpenClaw supports Grok as a `web_search` provider, using xAI web-grounded responses to produce AI-synthesized answers backed by live search results with citations. diff --git a/docs/tools/image-generation.md b/docs/tools/image-generation.md index a09842f9fa9..200c752ebe1 100644 --- a/docs/tools/image-generation.md +++ b/docs/tools/image-generation.md @@ -7,8 +7,6 @@ read_when: title: "Image Generation" --- -# Image Generation - The `image_generate` tool lets the agent create and edit images using your configured providers. Generated images are delivered automatically as media attachments in the agent's reply. diff --git a/docs/tools/index.md b/docs/tools/index.md index efa37d285d0..d44f790f965 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -7,8 +7,6 @@ read_when: title: "Tools and Plugins" --- -# Tools and Plugins - Everything the agent does beyond generating text happens through **tools**. Tools are how the agent reads files, runs commands, browses the web, sends messages, and interacts with devices. diff --git a/docs/tools/kimi-search.md b/docs/tools/kimi-search.md index 4df4c5a062a..98cadbba299 100644 --- a/docs/tools/kimi-search.md +++ b/docs/tools/kimi-search.md @@ -6,8 +6,6 @@ read_when: title: "Kimi Search" --- -# Kimi Search - OpenClaw supports Kimi as a `web_search` provider, using Moonshot web search to produce AI-synthesized answers with citations. diff --git a/docs/tools/llm-task.md b/docs/tools/llm-task.md index 5a7185aeba3..928785a0420 100644 --- a/docs/tools/llm-task.md +++ b/docs/tools/llm-task.md @@ -6,8 +6,6 @@ read_when: title: "LLM Task" --- -# LLM Task - `llm-task` is an **optional plugin tool** that runs a JSON-only LLM task and returns structured output (optionally validated against JSON Schema). diff --git a/docs/tools/lobster.md b/docs/tools/lobster.md index ee3e235c726..c0f3d1f1bc1 100644 --- a/docs/tools/lobster.md +++ b/docs/tools/lobster.md @@ -6,8 +6,6 @@ read_when: - You need to resume a workflow without re-running earlier steps --- -# Lobster - Lobster is a workflow shell that lets OpenClaw run multi-step tool sequences as a single, deterministic operation with explicit approval checkpoints. Lobster is one authoring layer above detached background work. For flow orchestration above individual tasks, see [Task Flow](/automation/taskflow) (`openclaw tasks flow`). For the task activity ledger, see [`openclaw tasks`](/automation/tasks). diff --git a/docs/tools/loop-detection.md b/docs/tools/loop-detection.md index d0071cf5064..48152dcfeda 100644 --- a/docs/tools/loop-detection.md +++ b/docs/tools/loop-detection.md @@ -7,8 +7,6 @@ read_when: - You are editing agent tool/runtime policies --- -# Tool-loop detection - OpenClaw can keep agents from getting stuck in repeated tool-call patterns. The guard is **disabled by default**. diff --git a/docs/tools/minimax-search.md b/docs/tools/minimax-search.md index 1b7f5cd6ee0..577defd8646 100644 --- a/docs/tools/minimax-search.md +++ b/docs/tools/minimax-search.md @@ -7,8 +7,6 @@ read_when: title: "MiniMax Search" --- -# MiniMax Search - OpenClaw supports MiniMax as a `web_search` provider through the MiniMax Coding Plan search API. It returns structured search results with titles, URLs, snippets, and related queries. diff --git a/docs/tools/music-generation.md b/docs/tools/music-generation.md index e6a8cb39592..31a4cf122a7 100644 --- a/docs/tools/music-generation.md +++ b/docs/tools/music-generation.md @@ -7,8 +7,6 @@ read_when: title: "Music Generation" --- -# Music Generation - The `music_generate` tool lets the agent create music or audio through the shared music-generation capability with configured providers such as Google, MiniMax, and workflow-configured ComfyUI. diff --git a/docs/tools/ollama-search.md b/docs/tools/ollama-search.md index 71b465e4a95..b2accb55bd7 100644 --- a/docs/tools/ollama-search.md +++ b/docs/tools/ollama-search.md @@ -7,8 +7,6 @@ read_when: title: "Ollama Web Search" --- -# Ollama Web Search - OpenClaw supports **Ollama Web Search** as a bundled `web_search` provider. It uses Ollama's experimental web-search API and returns structured results with titles, URLs, and snippets. diff --git a/docs/tools/pdf.md b/docs/tools/pdf.md index 1a08185d65a..682e5eaaac1 100644 --- a/docs/tools/pdf.md +++ b/docs/tools/pdf.md @@ -7,8 +7,6 @@ read_when: - You are debugging native PDF mode vs extraction fallback --- -# PDF tool - `pdf` analyzes one or more PDF documents and returns text. Quick behavior: diff --git a/docs/tools/plugin.md b/docs/tools/plugin.md index 84251dcf2dd..3da2fb28bb0 100644 --- a/docs/tools/plugin.md +++ b/docs/tools/plugin.md @@ -8,8 +8,6 @@ title: "Plugins" sidebarTitle: "Install and Configure" --- -# Plugins - Plugins extend OpenClaw with new capabilities: channels, model providers, tools, skills, speech, realtime transcription, realtime voice, media-understanding, image generation, video generation, web fetch, web diff --git a/docs/tools/reactions.md b/docs/tools/reactions.md index 98bd1d96cfd..d71e9cbb2d9 100644 --- a/docs/tools/reactions.md +++ b/docs/tools/reactions.md @@ -6,8 +6,6 @@ read_when: title: "Reactions" --- -# Reactions - The agent can add and remove emoji reactions on messages using the `message` tool with the `react` action. Reaction behavior varies by channel. diff --git a/docs/tools/searxng-search.md b/docs/tools/searxng-search.md index aa6a223f954..e0fa9c10d2d 100644 --- a/docs/tools/searxng-search.md +++ b/docs/tools/searxng-search.md @@ -7,8 +7,6 @@ read_when: title: "SearXNG Search" --- -# SearXNG Search - OpenClaw supports [SearXNG](https://docs.searxng.org/) as a **self-hosted, key-free** `web_search` provider. SearXNG is an open-source meta-search engine that aggregates results from Google, Bing, DuckDuckGo, and other sources. diff --git a/docs/tools/skills-config.md b/docs/tools/skills-config.md index ddf84ac5b20..2664f7285e8 100644 --- a/docs/tools/skills-config.md +++ b/docs/tools/skills-config.md @@ -6,8 +6,6 @@ read_when: title: "Skills Config" --- -# Skills Config - Most skills loader/install configuration lives under `skills` in `~/.openclaw/openclaw.json`. Agent-specific skill visibility lives under `agents.defaults.skills` and `agents.list[].skills`. diff --git a/docs/tools/slash-commands.md b/docs/tools/slash-commands.md index d6b0fd15db9..f1d8d0b5088 100644 --- a/docs/tools/slash-commands.md +++ b/docs/tools/slash-commands.md @@ -6,8 +6,6 @@ read_when: title: "Slash Commands" --- -# Slash commands - Commands are handled by the Gateway. Most commands must be sent as a **standalone** message that starts with `/`. The host-only bash chat command uses `! ` (with `/bash ` as an alias). diff --git a/docs/tools/subagents.md b/docs/tools/subagents.md index 28325475219..ac9e201449a 100644 --- a/docs/tools/subagents.md +++ b/docs/tools/subagents.md @@ -7,8 +7,6 @@ read_when: title: "Sub-Agents" --- -# Sub-agents - Sub-agents are background agent runs spawned from an existing agent run. They run in their own session (`agent::subagent:`) and, when finished, **announce** their result back to the requester chat channel. Each sub-agent run is tracked as a [background task](/automation/tasks). ## Slash command diff --git a/docs/tools/tavily.md b/docs/tools/tavily.md index 8b055a35116..d2674472445 100644 --- a/docs/tools/tavily.md +++ b/docs/tools/tavily.md @@ -8,8 +8,6 @@ read_when: title: "Tavily" --- -# Tavily - OpenClaw can use **Tavily** in two ways: - as the `web_search` provider diff --git a/docs/tools/tokenjuice.md b/docs/tools/tokenjuice.md index e03398d1a10..140cd3325cb 100644 --- a/docs/tools/tokenjuice.md +++ b/docs/tools/tokenjuice.md @@ -7,8 +7,6 @@ read_when: - You need to understand what tokenjuice changes and what it leaves raw --- -# Tokenjuice - `tokenjuice` is an optional bundled plugin that compacts noisy `exec` and `bash` tool results after the command has already run. diff --git a/docs/tools/trajectory.md b/docs/tools/trajectory.md index 4870cce96df..944a2ad0d93 100644 --- a/docs/tools/trajectory.md +++ b/docs/tools/trajectory.md @@ -8,8 +8,6 @@ read_when: title: "Trajectory Bundles" --- -# Trajectory bundles - Trajectory capture is OpenClaw's per-session flight recorder. It records a structured timeline for each agent run, then `/export-trajectory` packages the current session into a redacted support bundle. diff --git a/docs/tools/video-generation.md b/docs/tools/video-generation.md index eb46780b608..13524cd66cc 100644 --- a/docs/tools/video-generation.md +++ b/docs/tools/video-generation.md @@ -7,8 +7,6 @@ read_when: title: "Video Generation" --- -# Video Generation - OpenClaw agents can generate videos from text prompts, reference images, or existing videos. Fourteen provider backends are supported, each with different model options, input modes, and feature sets. The agent picks the right provider automatically based on your configuration and available API keys. diff --git a/docs/tools/web-fetch.md b/docs/tools/web-fetch.md index abb4a943e41..2b95ef73ea3 100644 --- a/docs/tools/web-fetch.md +++ b/docs/tools/web-fetch.md @@ -8,8 +8,6 @@ title: "Web Fetch" sidebarTitle: "Web Fetch" --- -# Web Fetch - The `web_fetch` tool does a plain HTTP GET and extracts readable content (HTML to markdown or text). It does **not** execute JavaScript. diff --git a/docs/tools/web.md b/docs/tools/web.md index 683af8671a2..523d7cb237d 100644 --- a/docs/tools/web.md +++ b/docs/tools/web.md @@ -9,8 +9,6 @@ read_when: - You want to understand auto-detection and provider fallback --- -# Web Search - The `web_search` tool searches the web using your configured provider and returns results. Results are cached by query for 15 minutes (configurable). diff --git a/docs/vps.md b/docs/vps.md index 7421131ea71..98691a0cdf4 100644 --- a/docs/vps.md +++ b/docs/vps.md @@ -8,8 +8,6 @@ title: "Linux Server" sidebarTitle: "Linux Server" --- -# Linux Server - Run the OpenClaw Gateway on any Linux server or cloud VPS. This page helps you pick a provider, explains how cloud deployments work, and covers generic Linux tuning that applies everywhere.