Skip to content

README.zh-CN.md

Latest commit

 

History

History
167 lines (123 loc) · 8.88 KB

README.zh-CN.md

File metadata and controls

167 lines (123 loc) · 8.88 KB
Raw
Codewhale

支持任意模型的开源编码智能体。

Codewhale 会读取你的项目、编辑文件、运行命令并检查自己的工作—— 在你的终端中，使用你选择的托管模型或本地模型。

CI crates.io npm License: MIT Discord

官网 · 文档 · 更新日志 · 参与贡献

English · 日本語 · Tiếng Việt · Bahasa Indonesia · 한국어 · Español · Português · Русский · Українська · Français · Deutsch · 繁體中文 · हिन्दी · Türkçe · Italiano · Polski · العربية · Català

一次 Codewhale 终端会话

全新安装后的真实终端截图——未经任何摆拍。

安装

macOS 和 Linux：

curl -fsSL https://codewhale.net/install.sh | sh

安装器会将经过校验和验证的二进制文件下载到 ~/.local/bin。如果之后运行 codewhale 提示 "command not found"，请运行安装器打印出的那一行 PATH 命令，或参阅 将它加入 PATH。 随时可以通过 codewhale update 升级。

Windows、npm、Cargo 及其他安装方式 
winget install HunterBown.CodeWhale  # Windows x64 (or Scoop, or the installer from GitHub Releases)
npm install -g codewhale            # wraps the same release binaries
cargo install codewhale-cli --locked  # build from crates.io

Docker、Nix、Linux 上的 Homebrew、Android/Termux、带校验和验证的手动下载， 以及可选的 CNB 镜像，都在安装指南中说明。请只选择一种方式： 同一台机器上安装多份，最终会在 PATH 上互相冲突。

快速开始

在一个地方管理你的模型 API 密钥。 注册 Codewhale 账号， 或运行 codewhale login 登录。将密钥保存到账号后，可以集中更新，并在已登录的设备上 通过 Codewhale 模型通道使用。设置账号密钥（英文版）。 登录不会自动上传已有的本地密钥；不注册账号也可以继续在本地使用。

  1. 打开你的项目。 在要处理的文件夹中运行 codewhale。
  2. 连接模型。 运行 /provider（或按 F3）添加托管服务的密钥，或选择本地运行时。 如果 Ollama 已在运行并带有聊天模型，Codewhale 会自动切换到它。使用 /model 更换模型。
  3. 给它一个具体的任务。
Fix the failing tests and explain what changed.

同一任务也可以在脚本或 CI 作业中以无界面方式运行：

codewhale exec "fix the failing tests and explain what changed"

运行 /help 查看命令和键盘快捷键。

运行方式

所有客户端都驱动同一个本地 Codewhale Runtime，因此会话、工具和权限在各处的行为一致。

命令 作用
codewhale 交互式终端界面
codewhale exec "…" 在脚本或 CI 中执行一次无界面对话轮次，以流式 JSON 输出
codewhale web 内置的本地浏览器客户端，监听 127.0.0.1
codewhale review --pr N 仅供参考的拉取请求审查；是否发布评论需主动开启
Runtime API 用于线程、事件和审批的本地 HTTP API

原生桌面应用（GPUI）正在作为需登录的产品客户端开发中；开放情况见 产品页面。由社区维护的 VS Code 扩展 可在侧边栏中连接同一个 Runtime（源码）。

功能

  • 任意模型，不被锁定。 内置超过 40 条提供商路由——Anthropic、DeepSeek、Google、 Mistral、Moonshot、OpenAI、OpenRouter、xAI 等——还支持任何兼容 OpenAI 的端点， 以及通过 Ollama、vLLM 或 SGLang 运行的本地模型。提供商
  • 由你掌控。 Plan 模式只探索、不做任何改动；Work 和 Operate 会进行修改。 审批姿态决定工具调用何时需要你的确认，/undo 和 /restore 可恢复工作区改动， /receipts 会列出一次会话中的每个文件、命令和审批。模式 · 回执
  • 为长时间任务而设计。 设定持久的 /goal，把有边界的工作委派给 子智能体，运行带有预算检查的受监督智能体团队， 或将它们编写为可纳入版本库的工作流。
  • 扩展你已在使用的工具。 连接 MCP 服务器，安装 技能和插件，在会话和工具事件上运行 钩子，并加载现有的 Claude Code 插件。
  • Computer Use。 内置插件提供观察和操作其他应用的工具。使用前请先查看其访问范围并启用。 指南

模式与权限

切换方式 选项
模式（Mode）——智能体正在做什么 Tab 或 /mode Plan（探索，不做改动）· Work（编辑并运行）· Operate（通过有计划、可验证的步骤推进一个目标）
姿态（Posture）——何时先征求同意 Shift+Tab Ask · Auto-Review · Full Access

Full Access 仍然遵守硬性策略边界。 模式与权限指南对每个选项都有说明。

安全

Codewhale 在你的机器上运行，只拥有你授予它的访问权限。审批姿态和仓库规则会限制智能体可以做的事， 在支持的平台上，命令会在操作系统沙箱中运行（macOS 上为 Seatbelt；Linux 上的 bubblewrap 需主动启用）。 /preview-request 会在发送任何内容之前显示经过脱敏的完整请求。 未知的模型价格会保持"未知"，而不会被报告为免费。

参见授权顺序、 沙箱和遥测——使用量计数默认开启， 运行 codewhale config set telemetry false 即可关闭。

文档

从这里开始 深入了解
安装 配置
提供商与本地模型 架构
模式与权限 Runtime API
快捷键 插件开发
GitHub PR 审查 全部文档

社区

欢迎提交缺陷报告、功能想法和拉取请求——无论你已使用 Codewhale 数月，还是第一次尝试。 如果缺少某个提供商，或某个工作流不顺手， 请提交 issue或 发送拉取请求。欢迎首次贡献， 被合并的工作会保留贡献者的署名。 仓库结构是一个不错的起点。

欢迎加入 Discord，或在微信上添加 Hunter （hunterbown），申请加入 Whale Brothers 群。

历史与许可证

Codewhale 最初名为 deepseek-tui，至今仍会读取该项目的配置和会话。 它现在与具体提供商无关，由独立团队维护，与任何模型提供商均无隶属关系。 感谢每一位贡献者，以及帮助它成长的开源社区。

MIT。改编自其他开源项目的部分记录在 第三方声明中。