Skip to content

附录 B:源码文件索引

本附录列出全书引用的所有源码文件路径,按模块分组,方便读者快速定位相关代码。

如何使用本附录

本索引覆盖 OpenClaw 源码中 23 个子系统、200+ 个关键文件。每个条目包含三列信息:

  • 文件路径:相对于仓库根目录的路径,可直接在 IDE 中 Ctrl+P 搜索打开
  • 说明:该文件的核心职责(一句话概括)
  • 相关章节:本书中详细讨论该文件的章节编号

阅读建议:初次阅读本书时无需逐行浏览本附录;当你在正文中遇到某个源码引用想了解其上下文时,回到这里按模块查找即可。如果你打算对 OpenClaw 进行二次开发,本索引也是快速建立代码地图的起点。


B.1 入口与核心

文件路径说明相关章节
src/entry.ts进程入口,启动哲学第1章
src/channel.ts通道主模块第7章
src/accounts.ts账户管理第8章

B.2 配置系统(src/config/

文件路径说明相关章节
src/config/types.ts配置类型定义(聚合导出)第3章
src/config/types.base.ts基础配置类型第3、5章
src/config/types.gateway.tsGateway 配置类型第3章
src/config/types.agents.tsAgent 配置类型第6章
src/config/types.channels.ts通道配置类型第7章
src/config/types.tools.ts工具配置类型第10章
src/config/types.skills.ts技能配置类型第16章
src/config/types.cron.ts定时任务配置类型第12章
src/config/types.secrets.ts凭证配置类型第13章
src/config/types.models.ts模型配置类型第4章
src/config/defaults.ts默认值与模型别名第3、4章
src/config/schema.ts配置 Schema 生成第3章
src/config/zod-schema.tsZod Schema 定义第3章
src/config/io.ts配置读写 I/O第3章
src/config/paths.ts配置路径解析第3章
src/config/includes.ts配置文件 include 机制第3章
src/config/env-vars.ts环境变量处理第3章
src/config/env-substitution.ts环境变量替换第3章
src/config/validation.ts配置校验第3章
src/config/logging.ts日志配置第15章
src/config/sessions.ts会话配置第5章
src/config/port-defaults.ts默认端口定义第3章

B.3 Gateway(src/gateway/

文件路径说明相关章节
src/gateway/config-reload.ts配置热重载第3章
src/gateway/config-reload-plan.ts重载计划生成第3章
src/gateway/server-methods/config.tsGateway 配置服务端第3章
src/gateway/protocol/schema/config.tsGateway 协议 Schema第3章

B.4 Agent 系统(src/agents/

文件路径说明相关章节
src/agents/system-prompt.ts系统提示组装第6章
src/agents/tool-policy-pipeline.ts工具策略管线第6、10章
src/agents/tool-policy.ts工具策略定义第6、10章
src/agents/tool-catalog.ts工具目录第10章
src/agents/openclaw-tools.tsOpenClaw 内置工具第10章
src/agents/pi-tools.tsPi Agent 工具第10章
src/agents/bash-tools.tsBash/Exec 工具第10章
src/agents/model-selection.ts模型选择逻辑第4章
src/agents/model-fallback.ts模型降级链第4章
src/agents/model-catalog.ts模型目录第4章
src/agents/models-config.ts模型配置第4章
src/agents/provider-capabilities.tsProvider 能力发现第4章
src/agents/provider-id.tsProvider ID 规范化第4章
src/agents/defaults.tsAgent 默认值第6章
src/agents/agent-scope.tsAgent 作用域第6章
src/agents/compaction.ts上下文压缩第5章
src/agents/context-window-guard.ts上下文窗口守卫第5章
src/agents/session-write-lock.ts会话写锁第5章
src/agents/usage.tsToken 用量统计第4章
src/agents/failover-error.ts故障转移错误处理第4章
src/agents/custom-api-registry.ts自定义 API 注册第4章
src/agents/auth-profiles.ts认证 Profile第4章
src/agents/auth-profiles/usage.ts认证用量第4章
src/agents/pi-embedded.tsPi 嵌入式 Runner第6章
src/agents/pi-embedded-runner.tsPi 嵌入式执行器第6章
src/agents/pi-embedded-subscribe.tsPi 嵌入式订阅第6章

Sub-agent 系统

文件路径说明相关章节
src/agents/subagent-spawn.tsSub-agent 创建第6、18章
src/agents/subagent-control.tsSub-agent 控制第6、18章
src/agents/subagent-registry.tsSub-agent 注册表第6章
src/agents/subagent-announce.tsSub-agent 完成通知第6章
src/agents/subagent-depth.tsSub-agent 深度控制第6章
src/agents/subagent-lifecycle-events.tsSub-agent 生命周期事件第6章
src/agents/acp-spawn.tsACP 模式 Sub-agent 创建第6章
src/agents/acp-spawn-parent-stream.tsACP 父流管理第6章

技能系统

文件路径说明相关章节
src/agents/skills.ts技能加载主逻辑第16章
src/agents/skills/config.ts技能配置第16章
src/agents/skills/types.ts技能类型定义第16章
src/agents/skills/workspace.ts技能工作区第16章
src/agents/skills/env-overrides.ts技能环境变量覆盖第16章
src/agents/skills-install.ts技能安装第16章

工具系统

文件路径说明相关章节
src/agents/tools/sessions-spawn-tool.ts会话创建工具第6章
src/agents/tools/sessions-send-tool.ts会话消息发送工具第6章

B.5 ACP(src/acp/

文件路径说明相关章节
src/acp/server.tsACP 服务端第6章
src/acp/client.tsACP 客户端第6章
src/acp/types.tsACP 类型定义第6章
src/acp/control-plane/manager.tsACP 控制面管理器第6章
src/acp/runtime/types.tsACP 运行时类型第6章
src/acp/runtime/session-identity.tsACP 会话身份第6章

B.6 通道系统(src/channels/

文件路径说明相关章节
src/channels/registry.ts通道注册表第7章
src/channels/ids.ts通道标识第7章
src/channels/plugins/registry.ts通道插件注册表第7章
src/channels/plugins/types.ts通道插件类型第7章
src/channels/plugins/bundled.ts内置通道插件第7章
src/channels/config-matching.ts配置匹配引擎第7章
src/channels/channel-config.ts通道配置第7章
src/channels/session.ts通道会话第7章
src/channels/run-state-machine.ts运行状态机第7章
src/channels/typing.ts打字指示第7章
src/channels/allow-from.ts来源白名单第7、13章
src/channels/command-gating.ts命令门控第7章
src/channels/mention-gating.ts@提及门控第7章
src/channels/inbound-debounce-policy.ts入站防抖策略第7章

B.7 通道实现(extensions/

文件路径说明相关章节
extensions/telegram/src/channel.tsTelegram 通道实现第8章
extensions/telegram/src/accounts.tsTelegram 账户管理第8章
extensions/discord/src/channel.tsDiscord 通道实现第8章
extensions/whatsapp/src/channel.tsWhatsApp 通道实现第8章
extensions/signal/src/channel.tsSignal 通道实现第8章
extensions/slack/src/channel.tsSlack 通道实现第8章
extensions/feishu/src/channel.ts飞书通道实现第8章
extensions/feishu/src/accounts.ts飞书账户管理第8章
extensions/feishu/src/conversation-id.ts飞书会话 ID 解析第8章

B.8 插件系统(src/plugins/

文件路径说明相关章节
src/plugins/registry.ts插件注册表第9章
src/plugins/loader.ts插件加载器第9章
src/plugins/types.ts插件类型定义第9章
src/plugins/hooks.ts插件钩子系统第9章
src/plugins/commands.ts插件命令第9章
src/plugins/discovery.ts插件发现第9章
src/plugins/config-schema.ts插件配置 Schema第9章
src/plugins/config-state.ts插件配置状态第9章
src/plugins/runtime/index.js插件运行时第9章
src/plugins/runtime/types.ts运行时类型第9章
src/plugin-sdk/config-runtime.tsSDK 运行时配置第9章
src/plugin-sdk/config-paths.tsSDK 路径配置第9章

B.9 浏览器自动化(src/browser/

文件路径说明相关章节
src/browser/profiles-service.ts浏览器 Profile 服务第10章
src/browser/navigation-guard.ts导航安全守卫第10章
src/browser/pw-role-snapshot.tsPlaywright 角色快照第10章
src/browser/snapshot-roles.ts快照角色解析第10章
src/browser/url-pattern.tsURL 模式匹配第10章
src/browser/config.ts浏览器配置第10章

B.10 Node 系统(src/node-host/

文件路径说明相关章节
src/node-host/config.tsNode Host 配置第11章

B.11 自动回复与钩子(src/auto-reply/

文件路径说明相关章节
src/auto-reply/skill-commands.ts技能命令触发第12章
src/auto-reply/reply/config-commands.ts配置命令回复第12章
src/auto-reply/reply/config-value.ts配置值回复第12章
src/auto-reply/reply/config-write-authorization.ts配置写入授权第13章

B.12 安全(src/secrets/

文件路径说明相关章节
src/secrets/configure-plan.ts凭证配置计划第13章

B.13 CLI(src/cli/

文件路径说明相关章节
src/cli/run-main.tsCLI 主入口第14章
src/cli/argv.tsCLI 参数解析第14章
src/cli/banner.tsCLI 启动横幅第14章
src/cli/banner-config-lite.ts轻量配置横幅第14章

B.14 日志(src/logging/

文件路径说明相关章节
src/logging/config.ts日志配置第15章
src/logging/logger.ts日志记录器第15章
src/logging/redact.ts日志脱敏第15章
src/logging/levels.ts日志级别定义第15章
src/logging/console.ts控制台日志第15章
src/logging/env-log-level.ts环境变量日志级别第15章

B.15 上下文引擎(src/context-engine/

文件路径说明相关章节
src/context-engine/types.tsContext Engine 类型定义第5章
src/context-engine/registry.tsContext Engine 注册表第5章
src/context-engine/legacy.tsLegacy Context Engine 实现第5章

B.16 定时任务(src/cron/

文件路径说明相关章节
src/cron/service.tsCron 服务主入口第12章
src/cron/service/ops.tsCron 操作第12章
src/cron/service/state.tsCron 状态管理第12章
src/cron/service/timer.tsCron 定时器第12章
src/cron/store.tsCron 存储第12章
src/cron/stagger.tsCron 错峰调度第12章
src/cron/types.tsCron 类型定义第12章

B.17 Daemon 管理(src/daemon/

文件路径说明相关章节
src/daemon/service.tsDaemon 服务管理第3、14章
src/daemon/systemd.tssystemd 集成第3、15章
src/daemon/systemd-unit.tssystemd unit 文件生成第15章
src/daemon/systemd-linger.tssystemd linger 配置第15章
src/daemon/launchd.tsmacOS launchd 集成第3章
src/daemon/launchd-plist.tslaunchd plist 生成第3章
src/daemon/schtasks.tsWindows 计划任务第3章
src/daemon/constants.tsDaemon 常量第3章
src/daemon/diagnostics.tsDaemon 诊断第3、15章
src/daemon/runtime-binary.ts运行时二进制定位第3章
src/daemon/service-audit.ts服务审计第15章

B.18 安全子系统(src/security/src/infra/

文件路径说明相关章节
src/security/audit.ts安全审计引擎第13章
src/security/dangerous-tools.ts危险工具检测第10、13章
src/security/dangerous-config-flags.ts危险配置标志第13章
src/security/external-content.ts外部内容安全第13章
src/security/fix.ts安全自动修复第13章
src/infra/exec-approvals.tsExec 审批流第13章
src/infra/exec-safety.tsExec 安全策略第10、13章
src/infra/net/ssrf.tsSSRF 防护第10、15章
src/infra/heartbeat-runner.ts心跳运行器第12章

B.19 会话管理(src/sessions/

文件路径说明相关章节
src/sessions/session-id.ts会话 ID 生成第5章
src/sessions/send-policy.ts发送策略第5章
src/sessions/model-overrides.ts模型覆盖第5章
src/sessions/level-overrides.ts级别覆盖第5章
src/sessions/input-provenance.ts输入来源追踪第5章
src/sessions/session-lifecycle-events.ts会话生命周期事件第5章
src/sessions/transcript-events.ts对话记录事件第5章

B.20 记忆系统(src/memory/

文件路径说明相关章节
src/memory/index.ts记忆系统入口第5章
src/memory/manager.ts记忆管理器第5章
src/memory/hybrid.ts混合搜索引擎第5章
src/memory/types.ts记忆类型定义第5章

B.21 TUI(src/tui/

文件路径说明相关章节
src/tui/tui.tsTUI 主入口第14章
src/tui/commands.tsTUI 命令注册第14章
src/tui/tui-command-handlers.tsTUI 命令处理器第14章
src/tui/tui-event-handlers.tsTUI 事件处理器第14章
src/tui/tui-formatters.tsTUI 格式化第14章
src/tui/tui-local-shell.tsTUI 本地 Shell第14章
src/tui/tui-overlays.tsTUI 覆盖层第14章
src/tui/theme/theme.tsTUI 主题第14章

B.22 路由与基础设施

文件路径说明相关章节
src/routing/session-key.tsSession Key 路由解析第5、7章
src/routing/resolve-route.ts路由解析第7章
src/infra/backoff.ts退避策略第4章
src/infra/restart.ts重启管理第3章
src/gateway/boot.tsGateway 引导启动第3章
src/gateway/server-startup.tsGateway 服务启动第3章
src/gateway/server-restart-sentinel.ts重启哨兵实现第3章
src/gateway/server-http.tsGateway HTTP 服务第3章
src/gateway/server-ws-runtime.tsGateway WebSocket 运行时第3章
src/gateway/channel-health-monitor.ts通道健康监控第15章
src/gateway/auth-rate-limit.ts认证限速第13章

B.23 部署文件

文件路径说明相关章节
DockerfileDocker 多阶段构建第15章
docker-compose.ymlDocker Compose 编排第15章

说明:本索引基于全书正文中引用的源码路径编制。OpenClaw 源码仓库结构可能随版本迭代而变化,建议以 main 分支最新代码为准。

基于 VitePress 构建