Codewhale 文档
版本最新发布 v0.10.1 · 2026年10月8日本站文档描述的是尚未发布的 v0.10.2 源码候选版。更新日志 →

安装与使用 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

日常使用

7

扩展与自动化

7

获取帮助

2

参考

3

“网页指南”条目在 codewhale.net 上打开;“源文档”条目会打开 GitHub 仓库中的完整参考资料。