Code Assistant

代码助手

这是一款用 Rust 编写的开源 AI 编码 Agent，提供原生 GUI、终端模式，以及与编辑器和 MCP 客户端的集成。它会在你的代码库中自主运行 Agent 循环——读取、搜索和编辑文件，以及运行命令——同时让你了解它实际在做什么。

开始使用

最快的体验方式是下载预构建版本——无需工具链：

1. 从Releases 页面下载最新版本：
   • macOS： Code-Assistant-macos-aarch64.app.zip（Apple Silicon）或 Code-Assistant-macos-x86_64.app.zip（Intel）
   • Linux： code-assistant-linux-x86_64.zip
   • Windows： code-assistant-windows-x86_64.zip
2. 启动应用。首次启动时，code-assistant 会打开设置页面。 选择一个提供方（常用提供方有一键推荐选项），粘贴 API 密钥并选择模型，就完成了。
3. 在应用中添加项目文件夹，然后开始聊天。

无需手动编辑 JSON 文件即可开始使用。（如果你愿意，也可以手动编辑——请参阅配置指南。）

# Install the Rust toolchain (macOS/Linux)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# On Linux (Debian/Ubuntu), install the system libraries gpui needs:
sudo apt-get install -y --no-install-recommends \
    pkg-config build-essential libssl-dev libzstd-dev \
    libfontconfig-dev libwayland-dev libx11-xcb-dev \
    libxkbcommon-x11-dev libasound2-dev libvulkan1

# On macOS, install the metal toolchain:
xcodebuild -downloadComponent MetalToolchain

# Clone and build
git clone https://github.com/stippi/code-assistant
cd code-assistant
cargo build --release

与众不同之处

以下是我们看重的一些特点：

• 清晰易懂的界面。 code-assistant 不会只显示一句简短的“调用了 5 个工具”，而是会展示运行了哪些工具，以及每个工具返回了什么内容作为模型的上下文。出现异常时，你可以看出原因。
• 保存时格式化，同时节省 token。 项目自动格式化代码后，Agent 对文件的理解可能会过时，后续编辑也会因此莫名失败。code-assistant 会运行格式化工具，然后将模型自身的修改与格式化后的结果协调一致，而无需浪费 token 重新读取文件。请参阅 docs/format-on-save-feature.md。
• 文件编码和换行符透明可控。 无论文件以何种方式存储（编码、BOM、CRLF/LF），它都会按原样读取，为模型提供整洁的文本，并按原样写回——绝不会悄悄改写你的换行符。
• 搜索和读取文档，不限于代码。 Word、Excel、PowerPoint、PDF 等文件都会自动转换为 Markdown，因此你可以让 Agent 同时处理实际文档和源代码。

功能

• 多个大模型提供商： Anthropic、OpenAI、Google Vertex AI、Ollama、 OpenRouter、SAP AI Core、Groq、Cerebras、Mistral 等。
• 四种工作方式： 原生 GUI（基于 Zed 的 GPUI 构建）、终端模式、无头 MCP 服务，以及适用于 Zed 等编辑器的 ACP Agent。
• 自适应工具语法： 原生函数调用、XML 标签或三重插入符代码块——按会话选择，以适配模型。
• 实时流式传输，并通过智能筛选阻止不安全的工具组合（例如，读取文件前先编辑文件）。
• 按项目划分的会话，支持分支、持久状态，以及带附件的草稿消息。
• **子 Agent、权限层级、命令沙箱，**以及上下文窗口填满时自动压缩上下文。
• MCP 客户端模式： 接入外部 Model Context Protocol 服务并使用其工具。
• 浏览器会话： Agent 驱动真实浏览器（导航、读取、点击、输入）来测试 Web 应用，并通过人在环路中的登录交接，让它以你的身份操作，同时完全不会接触你的凭据。
• 技能： 可重复使用、针对特定任务的操作指南，Agent 可按需加载。
• 自动加载的指引： 从项目根目录读取 AGENTS.md（或 CLAUDE.md），以遵循特定仓库的指令。

界面

code-assistant                     # native GUI (default)
code-assistant --tui               # terminal interface
code-assistant acp                 # ACP agent for editors like Zed
code-assistant server              # headless MCP server (e.g. Claude Desktop)

任何模式都可以接收初始任务：code-assistant --task "Explain this codebase"。

{
  "agent_servers": {
    "Code-Assistant": {
      "command": "/path/to/code-assistant",
      "args": ["acp", "--model", "Claude Sonnet 4.5"],
      "env": { "ANTHROPIC_API_KEY": "sk-ant-..." }
    }
  }
}

{
  "mcpServers": {
    "code-assistant": {
      "command": "/path/to/code-assistant",
      "args": ["server"],
      "env": { "SHELL": "/bin/zsh" }
    }
  }
}

配置

对大多数人来说，应用内的 Settings 界面就足够了——它会为你管理提供商、 模型、MCP 服务和技能。你也可以通过 JSON 文件配置所有内容，还可以使用更多高级选项（项目设置、沙箱模式、 工具语法、会话录制、CLI 标志）：

→ 请参阅配置指南。

贡献

欢迎贡献！这个代码库可以带你了解异步 Rust、AI Agent 架构和跨平台 UI。如果 Agent 的某些行为让你恼火，这正是本项目关注的细节： 请提交 issue。

路线图

严格来说，这并非路线图——只是几个未来方向，不分先后：

• 阻止替换过时文件中的内容： 在模型即将对自上次读取后已发生更改的文件执行 replace_in_file 时及早检测，并给出有帮助的提示后拒绝操作。
• 压缩工具使用失败记录： 从历史记录中移除失败的工具调用／不匹配的搜索代码块，以节省 token。
• 记忆工具： 帮助 Agent 为项目逐步构建知识库。
• 加强沙箱限制： 将工具访问范围限制在项目内由 git 跟踪的文件。
• 搜索代码块的模糊匹配： 减少因精确匹配失败而导致的重复读取。