Wiki AI

OpenClaw 索引

48分钟阅读

OpenClaw 知识库内容目录。每个 wiki 页面按类型列出，附一行摘要。 阅读此文件以快速定位相关页面。 Last updated: 2026-05-22 | Total pages: 574

Entities

Concepts

核心架构

  • architecture — Gateway 单进程架构，WebSocket 协议，客户端/节点连接模型
  • agent — 单嵌入式 Agent 运行时，工作区引导文件，Skills 加载优先级
  • agent-loop — Agent 完整执行路径：消息接收→上下文→推理→工具→流式→持久化
  • agent-workspace — 工作区文件布局，引导文件，Git 备份策略
  • agent-runtimes — 运行时类型（PI/Codex/CLI），四层概念区分，选择优先级

会话与队列

  • session — 会话路由规则，DM 隔离，生命周期，存储位置
  • queue — 命令队列模式（steer/followup/collect），并发控制，Lane 架构
  • queue-steering — Steering 运行时边界，PI vs Codex 差异，各模式对比

上下文与记忆

  • context — 上下文组成，系统提示构建，工具 token 开销，持久化机制
  • context-engine — 可插拔上下文引擎，四个生命周期钩子，ownsCompaction 标志
  • memory — 记忆文件布局，Dreaming 机制，四种后端，自动记忆刷新
  • memory-builtin — 默认 SQLite 后端，FTS5+向量混合搜索，Embedding 提供商
  • memory-search — 双路检索（向量+BM25），时间衰减，MMR 多样性

流式输出

  • streaming — 块流式 vs 预览流式，分块算法，各渠道支持矩阵

多 Agent 与路由

  • multi-agent — 多 Agent 路由，binding 规则，agentId/accountId 隔离，跨 Agent 内存搜索
  • parallel-specialist-lanes — 并行专家通道设计模式，三阶段部署，通道契约模板
  • delegate-architecture — 组织级 Delegate Agent，能力分级（只读/代发/自治），IdP 权限配置

Channel 功能

  • docs/concepts/channel-docking — 跨 channel 会话切换（呼叫转移），identityLinks 配置，dock 命令
  • presence — Gateway 在线状态，客户端可见性，TTL 与去重规则
  • messages — 消息处理流水线，入站去重/防抖，队列模式，静默回复
  • typing-indicators — 打字指示器模式（never/message/thinking/instant），刷新频率配置
  • progress-drafts — 进度草稿，四种流式模式，各 channel 传输方式，最终化策略
  • markdown-formatting — Markdown IR 流水线，Slack/Telegram/Signal 渲染，表格处理

上下文管理

  • compaction — 对话压缩，自动/手动触发，可插拔 provider，与 Pruning 的区别
  • session-pruning — 工具结果裁剪，cache TTL 机制，Anthropic prompt caching 优化
  • refactor-codex-context-engine — Codex Harness 上下文引擎移植规范（草稿），context-engine 生命周期接入设计
  • plan-ui-channels — Channel 消息展示重构计划（语义 presentation 与原生 UI 解耦，已实现）
  • refactor-ui-channels — Channel UI 重构实现记录（presentation/delivery 合约，各 channel 渲染映射）
  • plan-canvas — Canvas 插件重构计划（从 core 迁移为 extensions/canvas 捆绑插件）
  • plan-ingress-core — Ingress Core 删除计划（channel 访问控制集中化，代码预算与删除波次）
  • refactor-access — Channel 访问清理（重定向至 plan-ingress-core）
  • refactor-acp — ACP 生命周期重构计划（lease 优先清理，session 所有权元数据，五阶段迁移）

Agent 人格与提示词

  • soul — SOUL.md 人格指南，好/坏规则示例，与 AGENTS.md 的分工
  • system-prompt — 系统提示词结构，bootstrap 文件注入，提示词模式，缓存优化

运维与监控

  • retry — 重试策略，模型/Discord/Telegram 重试行为，failover 触发条件
  • usage-tracking — 用量追踪，provider 支持列表，展示位置
  • commitments — 推断承诺，与 Reminders 的区别，heartbeat 投递机制

功能概览

  • features — OpenClaw 全功能特性总览（channel/agent/媒体/工具/界面）
  • experimental-features — 实验性功能，当前已记录 flag，localModelLean 详解

记忆扩展

  • dreaming — 后台记忆巩固（Light/Deep/REM 三阶段，自动提升到 MEMORY.md）
  • memory-honcho — Honcho AI 原生记忆（跨会话、用户建模、语义搜索）
  • memory-qmd — QMD 本地搜索 sidecar（BM25+向量+重排序，可索引额外目录）
  • active-memory — 主动记忆（对话前阻塞式子 Agent 注入相关记忆）

协议与 SDK

  • typebox — Gateway WebSocket 协议 Schema（TypeBox 驱动运行时验证和代码生成）
  • openclaw-sdk — App SDK（外部应用连接 Gateway 的公共客户端 API）
  • oauth — OAuth 认证（令牌汇聚点、PKCE 流程、多账号 profile 路由）

消息架构

  • message-lifecycle-refactor — 消息生命周期重构设计（统一 receive/send/live/state）
  • timezone — 时区处理（信封/工具载荷/系统提示三个表面）

QA 与测试

  • qa-e2e-automation — QA E2E 自动化框架（qa-lab/qa-channel/实时传输通道）
  • qa-matrix — Matrix QA（Docker Tuwunel 服务器，E2EE 覆盖）
  • mantis — Mantis 端到端可视化验证（Before/After 对比，PR 证据）
  • mantis-slack-desktop-runbook — Mantis Slack 桌面运行手册（VNC/水合模式/时间分析）

模型与提供商

  • models — 模型选择优先级，白名单，Session 内动态切换，CLI 命令
  • model-providers — 内置提供商列表，API Key 轮换，自定义代理配置
  • model-failover — Auth profile 轮换，冷却机制，回退链规则，选择来源策略

Tools

执行与代码

  • tool-exec — Shell 命令执行工具，多主机路由（sandbox/gateway/node），后台执行，PTY 支持
  • tool-exec-approvals — exec 审批策略，双层门控，YOLO 模式，per-agent 白名单
  • tool-exec-approvals-advanced — Safe Bins 快速路径，解释器绑定，审批转发到聊天频道
  • tool-elevated — Elevated 模式，沙箱逃逸执行，四种级别，多层发送者白名单
  • tool-code-execution — 远程沙箱 Python 执行（xAI），与本地 exec 的区别
  • tool-apply-patch — 结构化多文件 patch 编辑，支持 Add/Update/Delete/Move 操作
  • tool-diffs — 只读 diff 查看器，canvas URL 或 PNG/PDF 渲染，安全制品管理

浏览器

文档与媒体

  • tool-pdf — PDF 文档分析，原生 provider 模式（Anthropic/Google）与提取回退模式
  • tool-image-generation — 图像生成与编辑，8 个 provider，同步执行，透明背景支持
  • tool-video-generation — 视频生成，16 个 provider，异步任务，三种运行模式
  • tool-music-generation — 音乐生成，Google/MiniMax/ComfyUI，异步任务流
  • tool-tts — 文本转语音，14 个 provider，Auto-TTS，原生语音消息，Talk 集成
  • tool-media-overview — 媒体能力总览，provider 能力矩阵，同步/异步模式对比

搜索工具

  • tool-web — web_search/x_search 总览，12 个提供商对比，自动检测优先级
  • tool-web-fetch — web_fetch 工具，HTTP 抓取与 Readability 内容提取，Firecrawl 回退
  • tool-brave-search — Brave Search 提供商，llm-context 模式，国家/语言/时间过滤
  • tool-duckduckgo-search — DuckDuckGo 免费提供商（实验性 HTML 解析，无 API Key）
  • tool-exa-search — Exa 神经搜索，多种搜索模式，内置内容提取（highlights/text/summary）
  • tool-firecrawl — Firecrawl 搜索+抓取，反爬虫，web_fetch 回退提取器
  • tool-gemini-search — Gemini 搜索，Google Search grounding，AI 合成答案+引用
  • tool-grok-search — Grok 搜索，xAI web grounding，同 key 支持 x_search
  • tool-kimi-search — Kimi 搜索，Moonshot web search，严格 grounding 验证
  • tool-minimax-search — MiniMax 搜索，Token Plan API，CN/全球双端点
  • tool-ollama-search — Ollama Web 搜索，本地/托管双模式，无需 API Key
  • tool-perplexity-search — Perplexity 搜索，结构化结果，域名过滤，OpenRouter 兼容
  • tool-searxng-search — SearXNG 自托管元搜索，聚合多引擎，无 API Key
  • tool-tavily — Tavily 搜索+提取，深度搜索，tavily_extract URL 内容提取

Agent 工具

  • tool-tool-search — Tool Search，PI Agent 大型工具目录搜索（实验性）
  • tool-llm-task — LLM Task，工作流中的 JSON-only LLM 步骤，Schema 验证
  • tool-subagents — Sub-agents，后台 Agent 派生，嵌套编排，线程绑定
  • tool-acp-agents — ACP Agents，外部 harness 运行时（Claude Code/Cursor/Gemini CLI 等）
  • tool-acp-agents-setup — ACP Agents 安装配置，MCP 桥接，权限模式
  • tool-agent-send — Agent Send，CLI 触发 Agent 运行，程序化投递
  • tool-multi-agent-sandbox-tools — 多 Agent 沙箱与工具策略，8 层过滤优先级
  • tool-lobster — Lobster 工作流引擎，确定性管道，审批门控，可恢复状态

控制工具

  • tool-btw — BTW 侧边问题，临时侧边查询，不污染会话历史
  • tool-steer — Steer 命令，向活跃运行注入引导消息
  • tool-reactions — Reactions，跨平台 emoji 反应，reactionLevel 配置
  • tool-thinking — Thinking 级别，fast/verbose/reasoning 指令，提供商映射
  • tool-tokenjuice — Tokenjuice，exec/bash 工具结果压缩，减少 token 消耗
  • tool-trajectory — Trajectory 轨迹导出，per-session 飞行记录器，调试支持包
  • tool-loop-detection — Loop Detection，工具循环检测，压缩后守卫

Skills 与插件

  • tool-skills — Skills 技能系统，AgentSkills 规范，加载优先级，Gating 过滤，快照机制
  • tool-skills-config — Skills 完整配置 schema（allowBundled/load/install/entries）
  • tool-creating-skills — 创建自定义 Skill 的步骤指南，SKILL.md 格式，最佳实践
  • tool-slash-commands — Slash Commands 完整参考（Commands/Directives/Inline shortcuts，配置，命令列表）
  • tool-plugin — 插件系统（安装/发现/启用规则/Plugin API/生命周期钩子）
  • tool-clawhub — ClawHub 公共 Skills 与插件注册表，发布流程，安全扫描
  • tool-capability-cookbook — 为 OpenClaw 核心添加新能力的贡献者指南（七步流程，职责分层）

Plugins

架构与构建

  • plugin-architecture — 插件公共能力模型，四种插件形状，能力分层（核心/厂商/Channel），兼容性信号
  • plugin-architecture-internals — 内部加载流水线（8步），注册表模型，43个 Provider 运行时钩子，缓存边界规则
  • plugin-building — 快速上手：工具插件/Channel 插件/Provider 插件开发，ClawHub 发布流程
  • plugin-building-extensions — 历史重定向页（内容已迁移至 plugin-building）
  • plugin-adding-capabilities — 贡献者指南：向核心添加新共享能力的7步标准序列
  • plugin-manifest — openclaw.plugin.json 完整 schema，activation/contracts/setup/modelCatalog 字段参考
  • plugin-bundles — Codex/Claude/Cursor Bundle 格式，MCP 工具映射，信任边界
  • plugin-compatibility — 兼容性注册表，废弃策略（7步迁移序列），当前兼容性领域
  • plugin-dependency-resolution — 依赖解析机制，安装根目录，npm/git/本地插件规则
  • plugin-install-overrides — 测试用安装覆盖，E2E 包验证，隔离状态目录
  • plugin-manage — 插件安装/更新/卸载/发布，ClawHub vs npm 来源选择
  • plugin-inventory — 插件清单：核心包内置（80+）、官方外部包（25+）、仅源码检出
  • plugin-community — 社区第三方插件列表，提交质量要求
  • plugin-oc-path — oc-path 插件，oc:// 工作区文件寻址，字节级精确编辑
  • plugin-hooks — 插件钩子系统，完整钩子目录，before_tool_call 决策规则，会话扩展

SDK

  • plugin-sdk-overview — Plugin SDK 概览：导入约定、注册 API（能力/工具/基础设施/工作流宿主钩子）
  • plugin-sdk-setup — Plugin SDK 安装与配置：package.json 元数据、清单、setup 入口、配置 Schema
  • plugin-sdk-entrypoints — Plugin SDK 入口点：definePluginEntry/defineChannelPluginEntry/defineSetupPluginEntry 及注册模式
  • plugin-sdk-runtime — Plugin SDK 运行时辅助工具：api.runtime 命名空间完整参考（agent/llm/subagent/tts/media 等）
  • plugin-sdk-subpaths — Plugin SDK 子路径目录：按用途分组的所有公开子路径
  • plugin-sdk-agent-harness — Plugin SDK Agent Harness：低级 Agent 执行器，实验性，仅受信任插件
  • plugin-sdk-channel-plugins — Plugin SDK Channel 插件构建：createChatChannelPlugin、DM 安全、配对、出站消息
  • plugin-sdk-channel-ingress — Plugin SDK Channel 入站授权：实验性访问控制边界，resolveChannelMessageIngress
  • plugin-sdk-channel-message — Plugin SDK Channel 消息生命周期：defineChannelMessageAdapter、持久化投递、回执、实时预览
  • plugin-sdk-channel-turn — Plugin SDK Channel 轮次内核：共享入站状态机（9 阶段流水线，4 种准入类型）
  • plugin-sdk-provider-plugins — Plugin SDK Provider 插件构建：注册 Provider、42 个钩子、共享家族构建器
  • plugin-sdk-migration — Plugin SDK 迁移指南：从废弃面（compat/infra-runtime）迁移到现代聚焦子路径
  • plugin-sdk-testing — Plugin SDK 测试工具：测试辅助子路径、契约测试、lint 规则
  • plugin-cli-backend — CLI 后端插件：本地 AI CLI 作为推理后端，CliBackendConfig，MCP 工具桥接
  • plugin-reference — 插件参考：完整插件清单（模型 Provider/Channel/工具/语音媒体分类）

特定插件

  • plugin-codex-harness — Codex Harness 插件：通过 Codex app-server 运行 OpenAI Agent 轮次，双传输模式，fail-closed 路由
  • plugin-codex-harness-reference — Codex Harness 配置参考：完整 appServer 字段、认证顺序、模型发现、环境隔离
  • plugin-codex-harness-runtime — Codex Harness 运行时：三层钩子架构、V1 支持契约、队列转向、诊断上传
  • plugin-codex-native-plugins — 原生 Codex 插件：openai-curated 插件迁移、三态管理、线程 app 配置、破坏性操作策略
  • plugin-codex-computer-use — Codex Computer Use：macOS 桌面控制 MCP 插件，自动安装，marketplace 选择，fail-closed
  • plugin-memory-lancedb — Memory LanceDB：LanceDB 向量记忆，多 embedding 提供商，自动召回/捕获，CLI 查询
  • plugin-memory-wiki — Memory Wiki：结构化知识库，声明溯源，仪表盘报告，bridge 模式，Obsidian 支持
  • plugin-message-presentation — 消息展示：跨 channel 富消息 UI 契约，按钮/选择/卡片，优雅降级，投递置顶
  • plugin-skill-workshop — Skill Workshop（实验性）：过程记忆，三种捕获路径，安全扫描器，提案生命周期
  • plugin-webhooks — Webhooks 插件：外部系统触发 TaskFlow，认证 HTTP 路由，速率限制，SecretRef 密钥
  • plugin-voice-call — Voice Call 插件：Twilio/Telnyx/Plivo 语音通话，实时语音/流式转录，入站策略，按号码路由
  • plugin-google-meet — Google Meet 插件：加入/创建会议，agent/bidi/transcribe 三种模式，Chrome/Twilio 传输，会议制品导出
  • plugin-zalouser — Zalo 个人账号插件：非官方 zca-js 自动化，QR 登录，消息/联系人/群组操作

插件全量参考目录

  • plugin-reference-catalog — 全量插件目录（117 个）：模型Provider/Channel/工具/语音媒体/迁移/QA 分类表，含包名和安装方式

工具深度参考

  • session-tools — Session 工具总览：7 个工具的功能、profile 可用性、可见性配置
  • sessions-spawn — sessions_spawn 完整参考：两种运行时、全参数表、嵌套深度、工具策略、配置、安全注意事项
  • cross-session-task-memory — 跨会话任务记忆：断层五环节分析、四种解决方案对比（强制写入/Dreaming+ActiveMemory/Sub-agent/Commitments）

CLI

  • cli-agent — openclaw agent：脚本化运行 Agent turn，Gateway/嵌入式模式，JSON 投递状态
  • cli-agents — openclaw agents：多 Agent 管理，binding 路由规则，身份配置
  • cli-plugins — openclaw plugins：插件安装/更新/卸载/inspect/doctor，来源格式，调试技巧
  • cli-hooks — openclaw hooks：hook 管理，内置 hook 说明，hook pack 安装
  • cli-skills — openclaw skills：skill 搜索/安装/更新/检查
  • cli-memory — openclaw memory：记忆索引/搜索/晋升，Dreaming 配置
  • cli-sessions — openclaw sessions：会话列表，清理维护，轨迹导出
  • cli-cron — openclaw cron：定时任务，session 类型，投递模式，模型配置
  • cron-ws-protocol — Cron WS 协议与 CLI 关系：cron.* RPC 方法对照表、架构层次、--json status 字段、持久化文件
  • cli-tasks — openclaw tasks：后台任务查看/取消/审计/维护，Task Flow
  • cli-mcp — openclaw mcp：MCP 服务端（serve）与客户端注册表（list/set/unset）
  • cli-index — CLI 命令完整索引：命令分组、全局标志、关键命令参考（status/health/gateway/models/config/logs/doctor）
  • cli-misc — CLI 其他命令：approvals/exec-policy/sandbox/tui/chat/infer

CLI 扩展命令

  • cli-acp — CLI - acp（ACP 桥接）：外部 harness 运行时桥接命令
  • cli-approvals — CLI - approvals 命令：工具审批策略管理
  • cli-backup — CLI backup 命令：工作区备份与恢复
  • cli-browser — CLI - browser 命令：浏览器控制与调试
  • cli-channels — CLI - channels 命令：Channel 配置与管理
  • cli-clawbot — CLI - clawbot（遗留别名）：旧版命令兼容
  • cli-commitments — CLI - commitments（承诺管理）：推断承诺查看与清理
  • cli-completion — CLI completion 命令：Shell 自动补全安装
  • cli-config — CLI config 命令：配置读写与验证
  • cli-configure — CLI configure 命令：交互式配置向导
  • cli-crestodian — CLI - crestodian（配置修复助手）：配置问题自动诊断修复
  • cli-daemon — CLI daemon 命令：后台守护进程管理
  • cli-dashboard — CLI - dashboard（Control UI）：启动 Web 控制界面
  • cli-devices — CLI - devices 命令：已配对设备列表与管理
  • cli-directory — CLI - directory（目录查询）：工作区路径查询
  • cli-dns — CLI dns 命令：DNS 解析与网络诊断
  • cli-doctor — CLI doctor 命令：环境健康检查与自动修复
  • cli-flows — CLI - flows（TaskFlow 管理）：任务流查看与控制
  • cli-gateway — CLI gateway 命令：Gateway 启动/停止/状态
  • cli-health — CLI health 命令：服务健康状态检查
  • cli-infer — CLI - infer 命令（推理 CLI）：直接调用模型推理
  • cli-logs — CLI logs 命令：日志查看与过滤
  • cli-message — CLI - message（消息发送）：向 Agent 发送消息
  • cli-migrate — CLI migrate 命令：数据迁移工具
  • cli-models — CLI - models 命令：模型列表与切换
  • cli-node — CLI - node 命令（无头节点主机）：节点主机模式启动
  • cli-nodes — CLI - nodes 命令：节点设备管理
  • cli-onboard — CLI - onboard（引导初始化）：首次运行引导流程
  • cli-pairing — CLI - pairing（配对管理）：设备配对审批与管理
  • cli-path — CLI - path（oc:// 路径操作）：工作区文件路径解析
  • cli-proxy — CLI proxy 命令：网络代理配置
  • cli-qr — CLI - qr（移动端配对二维码）：生成配对二维码
  • cli-reset — CLI reset 命令：重置配置或工作区
  • cli-sandbox — CLI - sandbox 命令：沙箱环境管理
  • cli-secrets — CLI secrets 命令：密钥管理（SecretRef）
  • cli-security — CLI security 命令：安全配置与审计
  • cli-setup — CLI setup 命令：初始化安装配置
  • cli-status — CLI status 命令：Gateway 与 Agent 运行状态
  • cli-system — CLI system 命令：系统信息与诊断
  • cli-tui — CLI - tui 命令（终端 UI）：启动终端聊天界面
  • cli-uninstall — CLI uninstall 命令：卸载 OpenClaw
  • cli-update — CLI update 命令：更新 OpenClaw 及插件
  • cli-voicecall — CLI - voicecall（语音通话）：语音通话管理命令
  • cli-webhooks — CLI - webhooks（Webhook 集成）：Webhook 注册与管理
  • cli-wiki — CLI - wiki（Memory Wiki 管理）：知识库索引与查询

Start（入门）

Install（安装部署）

  • install — 安装总览：安装脚本/npm/Docker/Kubernetes/Nix，更新，迁移，云平台部署

Install 详细指南

  • install-installer — 安装脚本详解：脚本参数，安装路径，权限要求
  • install-bun — Bun 运行时（实验性）：Bun 安装方式，性能对比
  • install-node — Node.js 安装：npm 全局安装，版本要求，PATH 配置
  • install-nix — Nix 安装：Nix flake，NixOS 模块，声明式配置
  • install-docker — Docker 安装：官方镜像，compose 配置，卷挂载
  • install-docker-vm-runtime — Docker VM 运行时（共享步骤）：VM 内 Docker 通用配置
  • install-kubernetes — Kubernetes 部署：Helm chart，ConfigMap，Secret，持久化存储
  • install-ansible — Ansible 自动化部署：Playbook，角色，变量配置
  • install-clawdock — ClawDock — Docker 管理助手：一键 Docker 部署工具
  • install-digitalocean — DigitalOcean 部署：Droplet 配置，一键部署，防火墙
  • install-azure — Azure 部署：Azure VM，容器实例，网络配置
  • install-gcp — GCP 部署：Cloud Run，Compute Engine，IAM 配置
  • install-hetzner — Hetzner 部署：Hetzner Cloud，服务器配置，防火墙规则
  • install-hostinger — Hostinger 部署：VPS 配置，SSH 访问，服务管理
  • install-oracle — Oracle Cloud 部署：Always Free 实例，网络，存储
  • install-fly — Fly.io 部署：fly.toml，Secrets，持久化卷
  • install-raspberry-pi — Raspberry Pi 部署：ARM 支持，性能优化，自启动
  • install-updating — 更新 OpenClaw：更新命令，版本管理，回滚
  • install-uninstall — 卸载 OpenClaw：完整卸载步骤，数据清理
  • install-migrating — 迁移指南：跨平台迁移，数据导出/导入
  • install-migrating-claude — 从 Claude 迁移：Claude Code 到 OpenClaw 迁移路径

Channels（渠道集成）

  • channels-overview — Channel 总览：支持列表，路由规则，配对机制，群组行为，访问组
  • channel-telegram — Telegram：Bot API，长轮询/Webhook，多账号配置
  • channel-whatsapp — WhatsApp：Baileys，QR 配对，双手机方案，访问控制
  • channel-discord — Discord：Bot API，特权 Intent，线程支持
  • channel-slack — Slack：Socket Mode vs HTTP Request URLs，多账号
  • channel-signal — Signal：signal-cli 集成，原生/容器双模式，DM 配对，群组策略
  • channel-line — LINE：Messaging API，webhook，Flex 消息，快速回复
  • channel-irc — IRC：经典频道/私信，两道访问门控，NickServ 认证
  • channel-mattermost — Mattermost：bot token + WebSocket，原生 slash 命令，流式预览，交互按钮
  • channel-nextcloud-talk — Nextcloud Talk：webhook bot，房间/私信，表情反应
  • channel-nostr — Nostr：NIP-04 加密私信，去中心化，relay 配置
  • channel-synology-chat — Synology Chat：webhook 双向，用户 ID 白名单，多账号
  • channel-twitch — Twitch：IRC 连接，角色/用户 ID 访问控制，token 自动刷新
  • channel-tlon — Tlon/Urbit：去中心化，ship 连接，owner 审批系统
  • channel-yuanbao — 元宝（Yuanbao）：腾讯 AI 助手，WebSocket，群聊/私信，流式输出
  • channel-zalo — Zalo：越南消息应用，Bot API，长轮询/webhook，实验性
  • channel-clickclack — ClickClack：bot token，channel/dm/thread 目标，权限范围
  • channel-imessage-bluebubbles — iMessage 从 BlueBubbles 迁移：配置对照，群组注册表陷阱，逐步迁移
  • channel-groups — 群组聊天行为：跨平台策略，mention 门控，工具限制，可见回复
  • channel-group-messages — WhatsApp 群组消息：激活模式，会话键，上下文注入
  • channel-access-groups — 访问组：可复用发送者白名单，Discord 动态受众，跨频道引用
  • channel-broadcast-groups — 广播群组：多 agent 并行/顺序处理，会话隔离，WhatsApp 支持
  • channel-routing — 频道路由：确定性路由规则，会话键格式，出站目标前缀
  • channel-pairing — 配对：DM 配对审批，节点设备配对，可信 CIDR 自动审批
  • channel-location — 位置解析：Telegram/WhatsApp/Matrix 位置规范化，上下文字段
  • channel-qa — QA 频道：合成消息传输，自动化测试，HTTP 总线
  • channel-troubleshooting — 频道故障排查：诊断命令梯队，各平台故障特征与修复
  • channel-matrix-presentation — Matrix 展示元数据：com.openclaw.presentation，富消息 block 类型

Channels 扩展

  • channels-index — Channels 总览：所有 Channel 导航索引
  • channel-docking — Channel Docking（跨频道切换）：identityLinks 配置，dock 命令，呼叫转移
  • channel-matrix — Channel - Matrix：Matrix 协议，E2EE，房间/私信，Tuwunel 服务器
  • channel-matrix-migration — Channel - Matrix 迁移指南：从旧版 Matrix 迁移步骤
  • channel-matrix-push-rules — Channel - Matrix 推送规则（quiet 流式预览）：推送规则配置
  • channel-imessage — Channel - iMessage：Apple Messages，imsg 集成，群组支持
  • channel-bluebubbles-announcement — BlueBubbles 移除公告与 imsg iMessage 迁移：迁移指南
  • channel-feishu — Channel - 飞书（Feishu/Lark）：飞书机器人，消息/群组/文档
  • channel-googlechat — Channel - Google Chat：Google Chat Bot，Space/DM，Webhook
  • channel-msteams — Channel - Microsoft Teams：Teams Bot，频道/私信，Adaptive Cards
  • channel-qqbot — Channel - QQ Bot：QQ 机器人，群聊/私信，OpenAPI
  • channel-wechat — Channel - 微信（WeChat）：企业微信/公众号，消息/群组

Gateway（网关）

  • gateway-runbook — Gateway 运维：启动/验证/配置/热重载，运行时模型
  • gateway-secrets — 密钥管理：SecretRef 类型，活跃面过滤，密钥操作命令
  • gateway-sandboxing — 沙箱配置：模式/范围/后端，沙箱浏览器，工具策略
  • gateway-heartbeat — 心跳配置：间隔/目标/轻量上下文，HEARTBEAT.md 格式
  • gateway-auth — 模型认证：API Key/OAuth/Claude CLI 复用，Auth profile 轮换
  • gateway-local-models — 本地模型：硬件要求，LM Studio/Ollama/vLLM 配置

Gateway 扩展参考

Providers（模型提供商）

  • providers — 提供商目录：完整提供商列表，主要提供商配置示例（Anthropic/OpenAI/Google/OpenRouter/Ollama/DeepSeek）
  • provider-models-index — 模型提供商总览：所有 provider 分类表（云端/开源聚合/中国区/本地/媒体/语音）

语音提供商

图像/视频生成提供商

  • provider-fal — fal 图像/视频生成，Flux/Seedance/HeyGen，queue-backed 异步
  • provider-runway — Runway 视频生成，gen4.5/veo3 系列，任务轮询 API
  • provider-vydra — Vydra 图像/视频/TTS，grok-imagine/veo3/kling，ElevenLabs 路由 TTS
  • provider-comfy — ComfyUI workflow 驱动图像/视频/音乐生成，本地+Cloud 双模式

推理加速/开源聚合提供商

  • provider-cerebras — Cerebras 高速推理，4 模型目录，128k 上下文，GLM/GPT-OSS/Qwen/Llama
  • provider-huggingface — HuggingFace Inference Providers，OpenAI 兼容路由，:fastest/:cheapest 策略
  • provider-nvidia — NVIDIA NIM，免费开放模型，Nemotron/Kimi/MiniMax/GLM
  • provider-together — Together AI，Kimi/Llama/DeepSeek/GLM，含视频生成
  • provider-fireworks — Fireworks AI，Kimi K2.x 系列，thinking 强制关闭
  • provider-deepinfra — DeepInfra 统一 API，聊天/图像/视频/TTS/STT/Embeddings 全能力
  • provider-chutes — Chutes TEE 安全模型，OAuth+API key 双认证，GLM/DeepSeek/Kimi

搜索提供商

  • provider-perplexity — Perplexity 网络搜索，pplx-/sk-or- 双传输，域名/语言/日期过滤

多能力提供商

  • provider-xai — xAI Grok，聊天/图像/视频/TTS/STT/web_search/x_search/code_execution
  • provider-synthetic — Synthetic Anthropic 兼容代理，MiniMax/Kimi/GLM/DeepSeek 等
  • provider-venice — Venice AI 隐私推理，Private+Anonymized 双模式，41 个模型

本地服务器提供商

  • provider-sglang — SGLang 本地 OpenAI 兼容服务器，自动模型发现
  • provider-vllm — vLLM 本地 OpenAI 兼容服务器，Qwen/Nemotron thinking 控制
  • provider-inferrs — inferrs 本地服务器，自定义 provider 配置，按需启动

托管/代理提供商

Z.AI / GLM

  • provider-zai — Z.AI GLM 模型，自动端点检测，区域端点选项，thinking 保留

主流云端提供商

  • provider-anthropic — Anthropic 提供商：Claude 系列模型，API Key 配置，Prompt Caching
  • provider-openai — OpenAI 提供商：GPT/o 系列，Responses API，Embeddings，TTS/STT
  • provider-google — Google 提供商：Gemini 系列，Search grounding，原生图像/视频/TTS
  • provider-deepseek — DeepSeek 提供商：R1/V3 系列，thinking 控制，OpenAI 兼容
  • provider-groq — Groq 高速推理：Llama/Qwen/DeepSeek，低延迟，工具调用
  • provider-mistral — Mistral 提供商：Mistral/Codestral 系列，FIM 补全，Embeddings
  • provider-openrouter — OpenRouter 聚合路由：多模型统一 API，自动 fallback，成本优化

中国区提供商

  • provider-alibaba — Alibaba Model Studio（阿里云 DashScope）：Qwen 系列，多模态，TTS/STT
  • provider-glm — GLM / Z.AI（智谱 AI）：GLM-4 系列，thinking，图像生成，Embeddings
  • provider-minimax — MiniMax：MiniMax-Text/VL，TTS/STT，视频生成，Token Plan API
  • provider-moonshot — Moonshot AI / Kimi：Kimi K2/K1.5，长上下文，web search
  • provider-qwen — Qwen 提供商：Qwen3 系列，thinking，多模态，Embeddings
  • provider-qianfan — 百度千帆（Qianfan）：ERNIE 系列，OpenAI 兼容端点
  • provider-tencent — Tencent Cloud TokenHub（腾讯云）：混元系列，OpenAI 兼容
  • provider-volcengine — Volcengine / Doubao（火山引擎）：Doubao 系列，TTS/STT，视频理解
  • provider-stepfun — StepFun（阶跃星辰）：Step 系列，长上下文，多模态
  • provider-xiaomi — 小米 MiMo（Xiaomi）：MiMo-7B 推理模型，OpenAI 兼容

本地/开源提供商

  • provider-ollama — Ollama 本地模型：自动发现，多模态，Embeddings，web search
  • provider-lmstudio — LM Studio 本地服务器：OpenAI 兼容，模型发现，Embeddings
  • provider-litellm — LiteLLM 代理：100+ 模型统一接口，负载均衡，成本追踪

云平台/代理提供商

Automation（自动化）

Nodes（节点设备）

  • nodes — 节点：配对，Canvas/相机/屏幕/位置命令，Talk 模式，Android 设备命令，Exec 节点绑定
  • nodes-index — Nodes 目录索引：节点概念、配对流程、命令策略、远程节点主机
  • nodes-audio — 音频与语音笔记：自动转录流水线，自动检测顺序，群组 mention 预检
  • nodes-camera — 摄像头捕获：iOS/Android/macOS 拍照与录像，前台要求，CLI 辅助
  • nodes-images — 图像与媒体支持：WhatsApp 媒体处理规则，出站发送上限，入站媒体模板变量
  • nodes-location-command — 位置命令：location.get 参数，权限模式，Android 前台要求，错误码
  • nodes-media-understanding — 媒体理解：图像/音频/视频摘要，模型条目类型，自动检测顺序，附件策略
  • nodes-talk — Talk 模式：原生 STT/TTS 循环，浏览器实时语音，语音指令，平台 UI
  • nodes-troubleshooting — 节点故障排查：诊断命令梯队，权限矩阵，配对 vs 审批三道门，错误码
  • nodes-voicewake — 语音唤醒：全局唤醒词列表，Gateway 存储，协议方法，平台行为差异

Platforms（平台）

  • platforms — 平台支持：macOS/Windows/Linux/iOS/Android 矩阵，Gateway 服务安装

Platforms 详细指南

Security（安全）

  • security — 安全：威胁模型（MITRE ATLAS），事件响应，网络代理，形式化验证
  • security-threat-model-atlas — 威胁模型（MITRE ATLAS）：信任边界架构，P0/P1 威胁汇总，关键攻击链，ClawHub 供应链控制
  • security-threat-model-contributing — 威胁模型贡献指南：贡献方式，威胁 ID 分类，风险级别，审查流程
  • security-formal-verification — 形式化验证：TLA+/TLC 安全模型，已验证声明，运行方式，重要注意事项
  • security-incident-response — 安全事件响应：检测分类，严重程度评估，响应流程，披露策略
  • security-network-proxy — 网络代理：正向代理配置，流量覆盖范围，Gateway loopback 模式，验证命令

Help（帮助）

  • help-faq — FAQ 与调试：60 秒诊断，常见问题，环境变量，调试工具
  • help-index — 帮助中心索引：帮助文档导航总览
  • help-debugging — 调试工具与方法：日志分析，诊断命令，常见错误排查
  • help-environment — 环境变量配置：所有支持的环境变量，优先级，示例
  • help-faq-first-run — FAQ：首次运行与安装：安装问题，初始化失败，权限错误
  • help-faq-models — FAQ：模型与认证：API Key 配置，模型不可用，认证失败
  • help-troubleshooting — 故障排查：系统性排查流程，常见故障模式
  • help-debug-node-issue — Node + tsx 崩溃调试：Node.js 运行时问题，tsx 编译错误
  • help-scripts — 仓库脚本说明：开发脚本，构建命令，测试工具
  • help-testing — 测试套件总览：测试框架，测试分类，运行方式
  • help-testing-live — 实时测试套件：集成测试，真实 Channel 测试，环境要求
  • help-testing-updates-plugins — 更新与插件测试：插件兼容性测试，更新验证流程
  • help-gpt55-codex-parity — GPT-5.5 / Codex Agentic 对等性：功能对比，迁移注意事项

Web UI

  • web-ui — Web UI：Control UI/Dashboard/WebChat，访问模式，认证，Tailscale 集成
  • web-index — Web 目录索引：界面组件总览，Tailscale 访问模式，安全要点
  • web-control-ui — Control UI：浏览器管理界面，设备配对，PWA/Web Push，Tailnet 访问，安全配置
  • web-dashboard — Dashboard：仪表板入口，认证方式，快速路径，1008 错误排查
  • web-tui — TUI：终端聊天界面，Gateway/本地双模式，键盘快捷键，slash 命令，配置修复工作流
  • web-webchat — WebChat：原生聊天 UI，WebSocket 方法，历史记录规范化，配置参考

Reference（参考）

  • reference — 参考：SecretRef 凭证面，Prompt Caching，Token 使用，RPC 适配器

Reference 详细文档

  • ref-secretref — SecretRef 凭证面（Credential Surface）：密钥类型，存储位置，引用语法
  • ref-prompt-caching — Prompt Caching（提示词缓存）：缓存策略，TTL，provider 支持矩阵
  • ref-token-use — Token 使用与费用：token 计算，费用追踪，优化建议
  • ref-api-usage-costs — API 使用与费用：provider 费率，用量报告，预算控制
  • ref-rpc — RPC 适配器：WebSocket RPC 方法，请求/响应格式，错误码
  • ref-rich-output-protocol — Rich Output 协议：富消息格式，block 类型，渲染规则
  • ref-session-compaction — 会话管理与压缩（深度参考）：压缩算法，触发条件，配置
  • ref-memory-config — Memory 配置参考：所有 memory 配置字段，后端选项
  • ref-device-models — 设备型号数据库：已知设备型号，能力矩阵，识别规则
  • ref-sdk-api-design — OpenClaw App SDK API 设计：SDK 设计原则，版本策略
  • ref-agents-default — 默认 AGENTS.md（个人助手配置）：默认配置模板，字段说明
  • ref-releasing — 发布策略（Release Policy）：版本号规则，发布流程，变更日志
  • ref-credits — Credits（项目致谢）：贡献者，依赖库，许可证
  • ref-wizard — Onboarding 向导参考：向导步骤，配置项，非交互模式
  • ref-transcript-hygiene — Transcript Hygiene（对话记录清洗）：清洗规则，隐私保护
  • ref-modernization-plan — 应用现代化计划：六阶段改进路线图，前端交付标准
  • ref-release-validation — 完整发布验证：顶层阶段，发布配置，聚焦重跑 handle，Docker 分片

Reference 模板

源码分析（src/）

Agents — Agent 运行时工具

  • read-tool — Read 工具实现分析：自适应分页、路径安全守卫、容器映射、图片 MIME 修正、Sandbox 模式
  • agent-reach — Agent Reach 互联网接入层：多平台内容读取、多后端路由、Skill 集成

Automation — 定时任务与自动化

  • cron-overview — Cron 调度模块总览：目录结构，模块依赖，关键常量
  • cron-types — Cron 核心数据结构：CronJob/CronSchedule/CronPayload/CronDelivery/CronJobState
  • cron-schedule — Cron 调度引擎：at/every/cron 三种模式，错开机制，错误退避
  • cron-service — Cron 服务层：生命周期，执行引擎，并发控制，持久化存储
  • cron-isolated-agent — Cron 隔离 Agent 执行：会话管理，模型选择，工具过滤，技能快照
  • cron-delivery — Cron 交付系统：announce/webhook 模式，失败通知，best-effort

Media — 媒体处理

  • image-backends — 图片处理后端对比：Sharp vs Sips，切换方法，平台适用性，功能边界，推荐策略

Queries

Notes（对话/实践总结，非官方文档）

  • cron-delivery — Cron 投递机制：Runner Fallback 原理、—best-effort-deliver、WebChat 无 channel 场景回写 session 方案
  • subagent-system-prompt — Sub-agent System Prompt 修改方案：核心机制、各方案对比、推荐方案、常见误区
  • subagent-system-prompt-basics — Sub-agent System Prompt 基础：各段落含义、AGENTS.md 方案、task 参数方案、两者叠加用法
  • subagent-prompt-inject-plugin — subagent-prompt-inject Plugin 完整实现：package.json + openclaw.plugin.json + index.ts + 启用方式
  • message-send-channels — openclaw message send 多 channel 发消息：飞书/企业微信/QQ/微信 target 格式、安装配置、主动发限制
  • message-tool — message Agent 工具完整参考：action 列表、presentation payload、NO_REPLY 机制、与 CLI 对比

此文件夹下有3条笔记。

  • docs

    • src

      • notes