Plandex：支持超长上下文的开源AI编码助手

综合介绍

Plandex 是一个开源的终端 AI 编码助手，专为大型复杂软件项目设计。它能规划和执行多步骤任务，处理高达 200 万 token 的上下文，支持 30 多种编程语言。Plandex 提供沙盒环境，隔离 AI 生成的代码变更，开发者可审查后再应用，确保项目安全。它支持 OpenAI、Anthropic、Google 等多种模型，用户可灵活切换以优化性能和成本。Plandex 提供全自动模式和精细控制，适合从初学者到专业开发者。安装简单，支持 Git 集成和版本控制，适用于个人和团队开发。官方提供云托管和本地部署选项，满足不同需求。

功能列表

• 大型项目管理：支持 200 万 token 上下文，索引目录可达 2000 万 token，适合超大代码库。
• 多模型支持：集成 OpenAI、Anthropic、Google 等模型，允许切换以优化性能和成本。
• 沙盒审查：AI 生成的代码变更存储在沙盒中，开发者可逐文件审查后应用，避免直接修改项目。
• 自动化调试：自动检测和修复终端命令错误，支持构建、测试、部署，兼容浏览器应用调试（需 Chrome）。
• 项目地图生成：通过 tree-sitter 快速生成项目地图，支持 30 多种语言，验证语法准确性。
• 版本控制：支持分支管理，探索多种实现路径，集成 Git 自动生成提交信息。
• 灵活自主性：提供全自动模式或逐步骤控制，适应不同任务复杂度和开发者偏好。
• 上下文管理：通过终端精确加载文件或目录，自动更新上下文，确保模型获取最新代码。
• REPL 交互模式：支持模糊自动补全的命令行交互，快速加载文件和执行任务。
• 本地化部署：支持 Docker 部署本地服务器，保护数据隐私，适合自托管需求。
• 聊天模式：项目感知的聊天功能，适合讨论代码、学习技术或规划任务。

使用帮助

安装流程

Plandex 提供简单安装方式，支持 Mac、Linux、FreeBSD 和 Windows（通过 WSL）。以下是详细步骤：

1. 安装 CLI：
   • 运行一键安装命令，无需额外依赖：

     curl -sL https://plandex.ai/install.sh | bash
     

   • 安装后，plandex 或 pdx 命令可用。
   • 验证安装：运行 plandex --version，检查版本号。
2. 本地部署服务器（可选）：
   • 需安装 Git、Docker 和 Docker Compose。
   • 克隆仓库并启动服务器：

     git clone https://github.com/plandex-ai/plandex.git
     cd plandex/app
     ./start_local.sh
     

   • 在新终端运行 plandex sign-in，选择“Local mode host”（默认 http://localhost:8099）。
   • 设置 API 密钥：

     export OPENROUTER_API_KEY=<your-openrouter-api-key>
     export OPENAI_API_KEY=<your-openai-api-key>
     

3. Windows 用户：
   • 仅支持 WSL 环境，需在 WSL 终端运行命令，不支持 Windows CMD 或 PowerShell。
4. 云托管选项：
   • Plandex Cloud（集成模型）：无需 API 密钥，支持多设备，包含每月 20 美元积分，适合快速上手。
   • Plandex Cloud（自带 API 密钥）：使用 OpenAI 和 OpenRouter 密钥，适合已有账户用户。
   • 访问 https://app.plandex.ai/start 注册并开始使用。

使用方法

Plandex 通过终端命令操作，核心功能包括任务规划、代码生成、审查和调试。以下是详细流程：

初始化项目

• 进入项目目录：

  cd your-project-dir
  

• （可选）初始化 Git 仓库：

  git init
  

• 启动 Plandex REPL：

  plandex
  

  或使用短命令：

  pdx
  

聊天模式

• 默认进入聊天模式，适合讨论项目或学习代码库：

  \chat 探索现有代码库中的认证逻辑
  

• Plandex 分析上下文并回答问题，开发者可逐步明确任务。

创建计划

• 切换到 tell 模式创建计划：

  \tell 添加用户认证功能，包括登录和注册
  

• Plandex 生成详细计划，列出步骤和所需文件，提示用户确认或调整。

加载上下文

• 添加文件或目录到上下文：

  plandex load path/to/file
  plandex load path/to/directory
  

• Plandex 自动更新上下文，确保模型使用最新代码。

审查变更

• 查看 AI 生成的代码变更：

  plandex changes
  

• 在终端 UI 中浏览差异，支持逐文件审查。接受变更：

  plandex apply
  

• 拒绝后可手动修改并重新加载。

自动化调试

• 执行终端命令（如构建或测试）：

  plandex run npm test
  

• 如果命令失败，Plandex 分析错误并生成修复建议。浏览器调试需 Chrome：

  plandex run --browser
  

版本控制

• 创建分支尝试不同实现：

  plandex branch feature-auth
  

• 回退到先前状态：

  plandex rewind
  

• 提交变更到 Git：

  plandex commit
  

• Plandex 自动生成提交信息。

切换模型

• 更改模型以优化性能或成本：

  plandex --model gemini-exp
  

• 或在 REPL 模式：

  \set-model deepseek-v3
  

特色功能操作

1. 大型项目支持：
   • Plandex 使用 tree-sitter 解析代码结构，生成项目地图。运行 plandex 自动索引项目，支持 Python、JavaScript、Go 等 30 多种语言。
   • 示例：处理 200 万 token 代码库时，Plandex 按需加载文件，减少 token 消耗。
2. 沙盒审查：
   • 变更存储在沙盒中，运行 plandex changes 查看差异。支持逐行审查，防止错误代码进入项目。
   • 示例：生成 50 个文件变更后，可在 UI 中逐一检查，确保逻辑和语法正确。
3. 自动化调试：
   • 运行测试命令时，Plandex 捕获错误并生成修复建议。例如：

     plandex run pytest
     

   • 浏览器调试支持 Chrome，自动分析前端错误。
4. 多模型优化：
   • 切换低成本模型（如 DeepSeek）：

     \set-model deepseek-v3
     

   • 模型切换不丢失上下文，适合长期任务。
5. 聊天模式：
   • 用于探索代码库或学习技术。例如：

     \chat 解释项目中的 OAuth 实现
     

   • Plandex 提供详细解答，附带代码示例。

注意事项

• API 密钥：云模式（自带密钥）或本地部署需设置 OpenAI 和 OpenRouter 密钥。
• 成本管理：启用上下文缓存（默认支持 OpenAI 和 Anthropic），选择低成本模型，精确加载上下文以降低费用。
• 社区支持：加入 Discord（https://discord.gg/plandex-ai）或 GitHub Discussions（https://github.com/plandex-ai/plandex/discussions）获取帮助。

应用场景

1. 大型代码库维护
   开发者维护超 200 万 token 的代码库时，Plandex 快速索引项目，生成项目地图。用户可加载模块，生成新功能或修复 bug，沙盒审查确保代码安全。
2. 新项目快速原型
   初创团队开发应用时，Plandex 规划 REST API、数据库模型等功能。全自动模式加速原型开发，分支管理支持多种架构尝试。
3. 跨技术栈学习
   开发者学习新语言（如 Rust）时，Plandex 的聊天模式解答问题，生成示例代码，帮助快速上手。
4. 自动化测试生成
   为项目添加测试时，Plandex 分析代码，生成单元测试。沙盒审查确保覆盖率，自动化调试修复失败用例。

QA

1. Plandex 支持哪些编程语言？
   Plandex 使用 tree-sitter 支持 30 多种语言，包括 Python、JavaScript、Go、Java、C++ 等，项目地图生成确保语法准确。
2. 如何降低使用成本？
   启用上下文缓存，选择低成本模型（如 DeepSeek），精确加载上下文文件以减少 token 消耗。
3. 能否本地运行 Plandex？
   是的，支持 Docker 部署本地服务器，使用 OpenAI 和 OpenRouter 密钥，数据不上传云端，保护隐私。
4. Plandex 与其他 AI 编码工具的区别？
   Plandex 专注大型项目，支持 200 万 token 上下文，提供沙盒审查和自动化调试，优于仅提供代码补全的工具。