mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-06 09:40:43 +00:00
docs: remove duplicate H1 where frontmatter title already sets it
This commit is contained in:
Vincent Koc
@@ -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`
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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."
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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**:
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -7,8 +7,6 @@ status: experimental
|
||||
title: "Broadcast Groups"
|
||||
---
|
||||
|
||||
# Broadcast Groups
|
||||
|
||||
**Status:** Experimental
|
||||
**Version:** Added in 2026.1.9
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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`.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -7,8 +7,6 @@ read_when:
|
||||
title: "Pairing"
|
||||
---
|
||||
|
||||
# Pairing
|
||||
|
||||
“Pairing” is OpenClaw’s explicit **owner approval** step.
|
||||
It is used in two places:
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -6,8 +6,6 @@ read_when:
|
||||
title: "Channel Troubleshooting"
|
||||
---
|
||||
|
||||
# Channel troubleshooting
|
||||
|
||||
Use this page when a channel connects but behavior is wrong.
|
||||
|
||||
## Command ladder
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -7,8 +7,6 @@ read_when:
|
||||
title: "WeChat"
|
||||
---
|
||||
|
||||
# WeChat
|
||||
|
||||
OpenClaw connects to WeChat through Tencent's external
|
||||
`@tencent-weixin/openclaw-weixin` channel plugin.
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -7,8 +7,6 @@ read_when:
|
||||
title: "mcp"
|
||||
---
|
||||
|
||||
# mcp
|
||||
|
||||
`openclaw mcp` has two jobs:
|
||||
|
||||
- run OpenClaw as an MCP server with `openclaw mcp serve`
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -5,8 +5,6 @@ read_when:
|
||||
title: "Agent Runtime"
|
||||
---
|
||||
|
||||
# Agent Runtime
|
||||
|
||||
OpenClaw runs a single embedded agent runtime.
|
||||
|
||||
## Workspace (required)
|
||||
|
||||
@@ -5,8 +5,6 @@ read_when:
|
||||
title: "Gateway Architecture"
|
||||
---
|
||||
|
||||
# Gateway architecture
|
||||
|
||||
## Overview
|
||||
|
||||
- A single long‑lived **Gateway** owns all messaging surfaces (WhatsApp via
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -5,8 +5,6 @@ read_when:
|
||||
title: "Features"
|
||||
---
|
||||
|
||||
# Features
|
||||
|
||||
## Highlights
|
||||
|
||||
<Columns>
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -7,8 +7,6 @@ read_when:
|
||||
title: "Messages"
|
||||
---
|
||||
|
||||
# Messages
|
||||
|
||||
This page ties together how OpenClaw handles inbound messages, sessions, queueing,
|
||||
streaming, and reasoning visibility.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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).
|
||||
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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"?
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -7,8 +7,6 @@ read_when:
|
||||
title: "Presence"
|
||||
---
|
||||
|
||||
# Presence
|
||||
|
||||
OpenClaw “presence” is a lightweight, best‑effort view of:
|
||||
|
||||
- the **Gateway** itself, and
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -6,8 +6,6 @@ read_when:
|
||||
title: "Retry Policy"
|
||||
---
|
||||
|
||||
# Retry policy
|
||||
|
||||
## Goals
|
||||
|
||||
- Retry per HTTP request, not per multi-step flow.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -6,8 +6,6 @@ read_when:
|
||||
title: "Usage Tracking"
|
||||
---
|
||||
|
||||
# Usage tracking
|
||||
|
||||
## What it is
|
||||
|
||||
- Pulls provider usage/quota directly from their usage endpoints.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -7,8 +7,6 @@ read_when:
|
||||
title: "Configuration"
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
OpenClaw reads an optional <Tooltip tip="JSON5 supports comments and trailing commas">**JSON5**</Tooltip> 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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
<CardGroup cols={2}>
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -6,8 +6,6 @@ read_when:
|
||||
title: "Help"
|
||||
---
|
||||
|
||||
# Help
|
||||
|
||||
If you want a quick “get unstuck” flow, start here:
|
||||
|
||||
- **Troubleshooting:** [Start here](/help/troubleshooting)
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -6,8 +6,6 @@ read_when:
|
||||
title: "Bun (Experimental)"
|
||||
---
|
||||
|
||||
# Bun (Experimental)
|
||||
|
||||
<Warning>
|
||||
Bun is **not recommended for gateway runtime** (known issues with WhatsApp and Telegram). Use Node for production.
|
||||
</Warning>
|
||||
|
||||
@@ -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.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user