文档 · Codewhale

搜索文档

入门

安装网页

npm、Cargo、Homebrew、Docker、预编译二进制、CNB 镜像，以及配置文件位置。

docs/INSTALL.md

使用指南网页

首次运行、会话、命令、快捷键和日常使用流程。

docs/GUIDE.md, docs/KEYBINDINGS.md

配置网页

config.toml 参考、环境变量、项目覆盖和旧版路径。

docs/CONFIGURATION.md, docs/LEGACY_PATHS.md

核心概念

产品名词网页

确切的产品名词——Fleet、Workflow、Lane、Runtime；Plan / Work / Operate；Consultant；明确的路由来源——以及测量原则。

docs/FLEET.md, docs/MODES.md, docs/public-surface-facts.json

嵌套宪章网页

Agent 自我模型、权威层次、证据规则和嵌套法律系统。

docs/ARCHITECTURE.md

模式网页

Plan、Work、Operate 三种模式与正交权限姿态。

docs/MODES.md

工具网页

小型核心工具、按需搜索、会话缓存与精确回放兼容边界。

docs/TOOL_SURFACE.md, docs/RUNTIME_SIMPLIFICATION_DESIGN.md

工作面板网页

唯一的 To-do 列表、模型如何通过自己的工具结果看到它，以及工作状态如何流向侧栏、relay 和子 Agent。

docs/TOOL_SURFACE.md, docs/TOOL_LIFECYCLE.md

子 Agent网页

并行执行、角色类型、transcript 句柄和嵌套。

docs/SUBAGENTS.md

沙箱与审批网页

可用的 Seatbelt（macOS）、显式启用的 bubblewrap（Linux）、平台缺口和审批策略。

docs/SANDBOX.md

参考

提供商与模型网页

支持的提供商、模型切换、本地运行时（vLLM、Ollama、SGLang）和模型实验室。

docs/PROVIDERS.md, docs/MODEL_LAB.md

扩展

MCP网页

Model Context Protocol — 通过 stdio 和 HTTP/SSE 消费和暴露工具。

docs/MCP.md

钩子网页

工具执行前后、模式切换和会话事件的生命周期钩子。

docs/rfcs/1364-hooks-lifecycle.md, docs/CONFIGURATION.md

技能源文档

安装、发现、信任并加载可复用的指令包。

docs/SKILLS.md

插件源文档

插件发现、安装、Bundle、信任边界与运行时生命周期。

docs/PLUGINS.md, docs/PLUGIN_BUNDLES.md

运行时 API网页

用于集成、桥接和自动化的公开 HTTP API。

docs/RUNTIME_API.md

浏览器客户端网页

仅在本机回环地址运行内置浏览器客户端，了解一次性引导与会话边界。

docs/WEB.md

运维与社区

Fleet / Workflow网页

持久任务执行、Fleet 管理和 Workflow 编写。

docs/FLEET.md, docs/WORKFLOW_AUTHORING.md

排障网页

常见问题、诊断、运维手册和 Docker 说明。

docs/OPERATIONS_RUNBOOK.md, docs/DOCKER.md

贡献源文档

贡献指南、Agent 伦理、贡献者致谢和发布流程。

CONTRIBUTING.md, docs/AGENT_ETHOS.md, docs/CONTRIBUTORS.md, docs/RELEASE_CHECKLIST.md

“网页”条目提供站内指南；“源文档”条目直接打开 GitHub 仓库中的完整参考资料。文档索引由仓库中的 docs-map.ts 注册表维护。

Codewhale 文档

入门

核心概念

参考

扩展

运维与社区