第6章 文档 · Codewhale

用 Codewhale 把事情做完。从你想做的事开始。每一页都会说明你需要准备什么，给出今天就能运行的命令，并指向下一步。搜索文档按任务18从你想完成的事情开始。安装 Codewhale在 macOS 或 Linux 上只需一条命令；也可以用 npm、Cargo、发布版二进制文件，或在 Linux 上用 Homebrew tap 安装。→开始第一个任务在项目中打开 Codewhale，先在 Plan 里了解项目，再让它在 Work 里动手修改。→连接模型提供商为 DeepSeek、OpenAI、Anthropic、OpenRouter 等提供商保存密钥，或者不用密钥运行本地模型。→选择或切换模型支持的提供商、在会话中切换模型，以及本地运行器。→决定哪些操作无需询问Plan、Work 或 Operate；Ask、Auto-Review 或 Full Access；以及如何回应审批提示。→查看改动查看每一处修改，把文件回滚到之前的回合，并在推送前做代码审查。→为审查保留收据生成审查收据，并在推送前核对它。→运行 Workflow编写可重复的 Workflow，把它作为 Lane 运行，并在任何终端查看或停止它。→并行运行 Agent角色、为并行修改准备的独立工作树，以及如何查看子 Agent。→用 MCP 连接工具添加本地或远程 MCP 服务器、用 OAuth 登录，或把 Codewhale 作为 MCP 服务器提供。→试用代码模式让模型在一段简短的程序中组合多个只读工具调用。实验性功能。→在事件发生时运行命令拦下危险命令、补充上下文，或在 Codewhale 等你回应时收到提醒。→限制命令的访问范围了解你的平台有哪种操作系统沙箱，并在 Linux 上开启 bubblewrap。→用 Runtime API 自动化在 CI 中运行一次性任务，或通过本地 HTTP API 驱动线程和审批。→打开浏览器客户端在本机浏览器标签页中工作，或用 /rc 在网页应用中继续会话。→把任务发送到云端预览版：提议并确认一个会提交拉取请求的云端 Agent。→排查问题用一条命令诊断，再解决安装、密钥、网络和回合卡住等问题。→了解哪些数据会离开本机提供商会收到什么、用量统计发送什么，以及如何关闭。→按主题24开始使用5安装 Codewhale网页安装脚本、npm、Homebrew tap、Cargo 与发布版二进制文件，以及每一步应有的输出。→开始第一个任务网页安装、连接模型，然后在你的项目里交给 Codewhale 一项任务。→连接模型提供商网页保存提供商密钥、查看当前使用的密钥、运行本地模型，或登录可选的账户。→选择模型网页支持的提供商、切换模型，以及 Ollama、vLLM、SGLang 等本地运行器。→修改设置网页找到配置文件，在会话或 shell 中修改设置，并了解仓库可以覆盖哪些设置。→日常使用7设置模式与审批网页用 Plan、Work、Operate 选择工作类型，用 Ask、Auto-Review、Full Access 决定它何时问你。→查看改动网页查看每一处修改，把文件回滚到之前的回合，做代码审查，并保留审查收据。→跟踪进度网页在工作栏中跟踪目标、To-do 列表和子 Agent，并把工作交接给新的会话。→并行运行 Agent网页把任务中独立的部分交给子 Agent，选择角色，并用工作树隔离并行修改。→运行 Workflow网页在 Fleet 中保存角色，编写可重复的 Workflow，把它作为 Lane 运行，并批量执行任务。→限制命令的访问范围网页macOS、Linux 和 Windows 上的操作系统沙箱、如何开启，以及命令能写到哪里。→了解哪些数据会离开本机网页哪些留在本地、提供商会收到什么、用量统计发送什么，以及如何关闭。→扩展与自动化7用 MCP 连接工具网页添加本地（stdio）或远程（HTTP）MCP 服务器、用 OAuth 登录、把 Codewhale 作为 MCP 服务器运行，并试用代码模式。→在事件发生时运行命令网页在会话开始、工具调用之前、回合结束或 Codewhale 等你回应时运行你自己的脚本。→添加技能源文档安装、查找、信任并加载可复用的指令包。↗添加插件源文档查找、安装、审查并信任插件包。↗用 Runtime API 自动化网页在脚本中运行一次性任务，或通过本地 HTTP API 驱动线程、事件和审批。→打开浏览器客户端网页在本机浏览器标签页中工作，或用 /rc 在网页应用中接着使用终端会话。→把任务发送到云端网页预览版：提议、确认并跟踪一个在 GitHub、CNB 或 Gitee 上提交拉取请求的云端 Agent。→获取帮助2排查问题网页用一条命令诊断，再解决安装、密钥、网络、回合卡住、会话和 MCP 等问题。→参与贡献源文档贡献指南、Agent 准则、贡献者致谢和发布流程。↗参考3产品名词网页Fleet、Workflow、Lane 与 Runtime；Plan、Work 与 Operate——各用一句话说明。→宪章网页Agent 视为准则的内容：内置规则、你的个人宪章，以及仓库自己的宪章。→内置工具网页每个会话默认携带的少量工具，以及 Codewhale 如何按需找到其余工具。→“网页”条目在 codewhale.net 上打开；“源文档”条目会打开 GitHub 仓库中的完整参考资料。