项目简介

plandex 是一个开源、基于终端的AI编程引擎，专为处理复杂任务而设计。

该项目利用长时运行的代理来完成涉及多个文件和多步骤的任务，将大任务拆分为更小的子任务，并逐个实现，直到完成整个工作。

plandex可以帮助用户快速推进工作进程，应对不熟悉的技术挑战，摆脱困境，减少在枯燥任务上的时间投入。

核心特性与优势

1. 构建复杂软件：借助LLMs（如OpenAI模型）的力量，可超越自动补全功能，构建复杂的软件功能。

2. 安全沙盒：更改在受保护的沙盒中累积，允许用户在自动应用到项目文件前对其进行审查。内置版本控制系统支持轻松回滚并尝试不同的方法。通过分支功能，用户可以试验多种方法并比较结果。

3. 高效管理上下文：在终端内高效管理上下文，轻松添加单个文件或整个目录到上下文中，并确保在工作过程中自动更新，确保模型始终具有项目最新状态。

4. 环境要求：目前依赖于OpenAI API，需要设置OPENAI_API_KEY环境变量。未来计划支持开源模型（如Google Gemini和Anthropic Claude）。

5. 跨平台兼容：支持Mac、Linux、FreeBSD和Windows系统，通过单一二进制文件运行，无需额外依赖。

安装与使用

以下是该项目的详细使用步骤：

安装

1. 快速安装：通过运行以下命令进行快速安装：

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

1. 手动安装：

• 前往最新版本发布页面下载与你平台对应的二进制文件。
• 将该文件放置到系统PATH中的某个位置，确保其可执行。

1. 从源码构建：

• 克隆项目仓库：

git clone https://github.com/plandex-ai/plandex.git
git clone https://github.com/plandex-ai/survey.git

• 进入plandex/app/cli目录并编译：

cd plandex/app/cli
go build -ldflags "-X plandex/version.Version=$(cat version.txt)"

• 将编译得到的plandex可执行文件移动到合适的位置（如/usr/local/bin）。

开始使用

1. 获取OpenAI API密钥：如果你还没有OpenAI账户，请先注册。然后在OpenAI控制台生成API密钥。

2. 设置环境变量：在你的项目目录下，设置OPENAI_API_KEY环境变量：

cd your-project
export OPENAI_API_KEY=your-api-key

1. 初始化项目：运行plandex new命令创建一个新的Plandex项目或与现有项目关联：

plandex new

使用Plandex

1. 命令帮助

• 查看所有可用命令：

plandex help

• 获取特定命令的帮助信息：

plandex [command] --help

1. 交互式工作流程

Plandex会在每次命令执行后提供可能的下一步操作建议。遵循这些建议快速学习并使用Plandex。

注意事项

• 审慎审查：尽管Plandex能显著提升生产力，但作为AI工具，不应期待完美结果。尤其是在涉及安全性的情况下，务必仔细审查计划后再应用更改。
• 迭代与分支：当发现结果稍有偏差时，通常需要迭代提示或添加上下文，再使用plandex rewind回溯并重试。分支有助于尝试不同方法。

未来规划

• 模型支持扩展：计划支持更多开源模型、Google Gemini、Anthropic Claude等。
• 协作与分享：引入计划共享与团队协作功能。
• 多模态支持：集成GPT4-Vision等多模态模型，支持添加图像和截图至上下文。
• IDE插件：开发VSCode和JetBrains插件。
• 社区插件与模块、GitHub集成、Web界面、SOC2合规、微调模型等。

小结

Plandex是一个强大的AI辅助编程工具，通过结合LLMs与高效的上下文管理机制，为开发者处理复杂编程任务提供了有力支持。