Plandex AI 编程助手使用教程

项目介绍

Plandex 是一个基于终端的开源 AI 编程引擎，旨在帮助程序员完成复杂的软件编程开发任务、解决不良输出并最大限度地提高生产力。该 AI 编程助手通过使用长期运行的智能体来完成跨越多个文件并需要多个步骤的任务，将大型任务分解为较小的子任务，然后逐一实现它们，直到完成整个软件开发工作。Plandex 旨在提高开发效率，帮助用户处理积压工作，掌握不熟悉的技术，并减少在重复性工作上的时间投入。

项目快速启动

安装 Plandex

首先，通过以下命令安装 Plandex：

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

注意：Windows 用户需要通过 WSL 来使用 Plandex。

配置 AI 服务 API 密钥

如果你还没有 AI 服务账户，请先创建并生成 API 密钥。然后将其导出：

export AI_API_KEY=your_ai_api_key

启动新项目

进入你的项目目录并启动新项目：

cd your-project-dir
plandex new

加载相关文件

加载项目中的相关文件到 Plandex 的上下文中：

plandex load some-file.ts another-file.ts
plandex load src/components -r
plandex load src --tree
plandex load src/**/*.ts
plandex load https://raw.githubusercontent.com/plandex-ai/plandex/main/README.md

发送提示

你可以通过文件、Vim 或内联方式发送提示：

plandex tell -f prompt.txt
plandex tell
plandex tell "add a new line chart showing the number of foobars over time to components/charts.tsx"

应用案例和最佳实践

案例一：快速构建新应用

使用 Plandex 可以快速规划并实现一个新应用的开发任务。例如，你可以通过以下步骤快速构建一个简单的 Web 应用：

1. 初始化新项目：

   plandex new
   

2. 加载项目文件：

   plandex load src/**/*.ts
   

3. 发送提示以添加新功能：

   plandex tell "add a new feature to handle user authentication"
   

案例二：代码审查和优化

Plandex 可以帮助你进行代码审查和优化。例如，你可以通过以下步骤对现有代码进行审查和改进：

1. 加载需要审查的代码文件：

   plandex load src/components/**/*.ts
   

2. 发送提示以进行代码审查：

   plandex tell "review and optimize the code in src/components/UserAuth.tsx"
   

典型生态项目

项目一：AI GPT-4

Plandex 默认使用 AI 服务的 GPT-4 模型，这是一个强大的语言模型，能够理解和生成高质量的代码。

项目二：Google Gemini

Plandex 还支持 Google Gemini 模型，这是一个开源的 AI 模型，可以用于更广泛的 AI 编程任务。

项目三：Anthropic Claude

Anthropic Claude 是另一个支持的模型，它提供了不同的 AI 编程能力，可以与 Plandex 结合使用以实现更复杂的编程任务。

通过这些生态项目的支持，Plandex 能够提供更全面和多样化的 AI 编程解决方案。