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