日常学习资料

Appearance

Return to top
On this page

Codebuff - 终端里的开源 AI 编码代理

是什么

Codebuff 是一个开源的终端 AI 编码代理，能理解整个代码库上下文，通过自然语言指令自动完成代码编写、重构、测试等任务。

  • GitHub： github.com/CodebuffAI/codebuff
  • 官网： codebuff.com
  • 创始人： Brett Beatty、James Beatty（YC F24）
  • 前身： 原名 Manicode
  • 安装方式： npm install -g codebuff
  • 定位： Claude Code 的开源竞品，终端编码代理

不是什么

  • 不是 IDE 插件（是独立 CLI，可在任何终端中使用）
  • 不是单一模型工具（支持任何 OpenRouter 上的模型）
  • 不是只读代码分析工具（会自动读写文件、执行命令）
  • 不是只支持 JavaScript/TypeScript 的工具（语言无关）

解决啥

痛点方案
被锁定在某家模型厂商支持 OpenRouter 上任何模型（Claude、GPT、Qwen、DeepSeek 等）
复杂项目的代码库理解困难自动扫描代码库，理解架构和依赖关系
手动跨文件修改耗时规划器自动识别需要修改的文件和顺序
团队缺乏统一的 AI 编码规范knowledge.md 文件提供项目上下文和编码指导
缺乏可扩展的自定义工作流支持用 TypeScript 编写自定义 Agent

好在哪

能力说明
多模型支持通过 OpenRouter 使用任意模型，不锁定厂商
多 Agent 架构File Explorer、Planner 等专业 Agent 协作
完整代码库理解自动扫描项目结构，理解文件间依赖
自定义 Agent用 TypeScript 编写专属 Agent，可发布到 Agent Store
Knowledge 机制knowledge.md 文件存储项目上下文和最佳实践
三种模式Free（快速）、Max（深度）、Plan（规划）
开源免费代码完全开源，本地运行
Agent Store可发布和下载社区 Agent
  • Y Combinator 孵化： F24 批次，已获知名风投支持
  • Agent Store： 类似 VSCode 插件市场，可发布/安装自定义 Agent
  • 自动执行： 需要时会自动运行命令（如 pip install、npm install）

怎么跑

安装

bash
npm install -g codebuff

要求：已安装 Node.js（含 npm）。

基本使用

bash
# 进入项目目录
cd /path/to/your-project

# 启动 Codebuff
codebuff

在交互式终端中输入自然语言指令：

  • "帮我写一个用户认证功能"
  • "为这些函数添加单元测试"
  • "重构这个模块，拆分逻辑"
  • "解释这段代码的工作原理"

初始化项目（可选）

在 Codebuff CLI 内执行 /init 命令，会生成：

  • knowledge.md — 项目上下文文件
  • .agents/types/ — Agent 类型定义
bash
codebuff
# 进入后输入
/init

使用不同模式

bash
codebuff         # 默认模式
codebuff --mode max   # Max 模式（更深度）
codebuff --mode plan  # Plan 模式（先规划后执行）

自定义 Agent

创建 .agents/my-agent.ts：

typescript
import type { AgentDefinition } from './types/agent-definition'

const definition: AgentDefinition = {
  id: 'code-reviewer',
  displayName: 'Code Reviewer',
  model: 'anthropic/claude-sonnet-4.5',
  toolNames: ['read_files', 'run_terminal_command', 'code_search'],
  systemPrompt: `你是资深代码审查专家。`,
  instructionsPrompt: `审查代码变更：
1. 查看 git diff
2. 检查潜在问题：bug、安全问题、风格问题
3. 给出具体改进建议`,
}

export default definition

发布到 Agent Store：

bash
# 需要先在 codebuff.com 创建 Publisher 账号
codebuff publish code-reviewer

怎么用

  • 全栈开发： 从零搭建功能模块，自动处理前后端、数据库
  • 重构迁移： "把 dark mode 改成 light mode" —— 自动扫描所有相关文件并修改
  • 测试覆盖： "为所有 API 端点写集成测试"
  • Bug 修复： "帮我定位这个报错的根因并修复"
  • 日常编码： 作为日常编码助手，在终端里直接对话

延伸： 配合 VS Code 或 Cursor 的内置终端使用效果更佳。也推荐搭配 knowledge.md 持续更新项目知识，让 Codebuff 越来越懂你的项目。

by 文殊