plandex README

The project's README from github.com/plandex-ai/plandex. As one markdown file: README.md.



30-Second Install · Website · Docs · Examples · Local Self-Hosted Mode


Discord GitHub Repo stars Twitter Follow

PRs Welcome Release Release


plandex-ai%2Fplandex | Trendshift

An AI coding agent designed for large tasks and real world projects.


Plandex v2 Demo Video

💻  Plandex is a terminal-based AI development tool that can plan and execute large coding tasks that span many steps and touch dozens of files. It can handle up to 2M tokens of context directly (~100k per file), and can index directories with 20M tokens or more using tree-sitter project maps.

🔬  A cumulative diff review sandbox keeps AI-generated changes separate from your project files until they are ready to go. Command execution is controlled so you can easily roll back and debug. Plandex helps you get the most out of AI without leaving behind a mess in your project.

🧠  Combine the best models from Anthropic, OpenAI, Google, and open source providers to build entire features and apps with a robust terminal-based workflow.

🚀  Plandex is capable of full autonomy—it can load relevant files, plan and implement changes, execute commands, and automatically debug—but it's also highly flexible and configurable, giving developers fine-grained control and a step-by-step review process when needed.

💪  Plandex is designed to be resilient to large projects and files. If you've found that others tools struggle once your project gets past a certain size or the changes are too complex, give Plandex a shot.

Smart context management that works in big projects

Tight control or full autonomy—it's up to you

Tools that help you get production-ready results

Dev-friendly, easy to install

Workflow  🔄

Plandex workflow

Examples  🎥


Plandex Browser Debugging Example

Install  📥

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

Note: Windows is supported via WSL. Plandex only works correctly on Windows in the WSL shell. It doesn't work in the Windows CMD prompt or PowerShell.

More installation options.

Hosting  ⚖️

Option Description
Plandex Cloud Winding down as of 10/3/2025 and no longer accepting new users. Learn more.
Self-hosted/Local Mode • Run Plandex locally with Docker or host on your own server.
• Use your own OpenRouter.ai key (or other model provider accounts and API keys).
• Follow the local-mode quickstart to get started.

Provider keys  🔑

export OPENROUTER_API_KEY=... # if using OpenRouter.ai

Claude Pro/Max subscription  🖇️

If you have a Claude Pro or Max subscription, Plandex can use it when calling Anthropic models. You'll be asked if you want to connect a subscription the first time you run Plandex.


Get started  🚀

First, cd into a project directory where you want to get something done or chat about the project. Make a new directory first with mkdir your-project-dir if you're starting on a new project.

cd your-project-dir

For a new project, you might also want to initialize a git repo. Plandex doesn't require that your project is in a git repo, but it does integrate well with git if you use it.

git init

Now start the Plandex REPL in your project:

plandex

or for short:

pdx

Docs  🛠️

👉  Full documentation.


Discussion and discord  💬

Please feel free to give your feedback, ask questions, report a bug, or just hang out:

Follow and subscribe


Contributors  👥

⭐️  Please star, fork, explore, and contribute to Plandex. There's a lot of work to do and so much that can be improved.

Here's an overview on setting up a development environment.

plandex (plandex-ai/plandex)

Searching Database…

15.8K ·GitHub
这是什么?Plandex 是一个在终端里运行的开源 AI 编程助手。它能够规划并执行跨多个步骤、涉及数十个文件的大型编码任务,专为真实项目打造。
怎么把它跑起来?用一条零依赖的一行命令安装 CLI,然后在任意项目目录里运行 plandex 就能启动 REPL。它还提供 Docker 本地模式,可以自己部署服务器。
用的时候需要我自己的 API 密钥或账号吗?需要——Plandex 使用你自己的服务商账号和 API 密钥,比如 OpenRouter.ai 的密钥。Claude Pro 或 Max 订阅也可以用来调用 Anthropic 的模型;首次运行时它会主动提示你进行连接。
它实际能处理多大的项目?它可以直接处理最多 2M token 的上下文(每个文件约 100k),并通过 tree-sitter 项目地图为超过 2000 万 token 的目录建立索引,支持 30 多种语言的语法校验。
在 Windows 上能用吗?只能通过 WSL 使用——Plandex 在 WSL shell 里运行正常,但在 Windows 的 CMD 命令提示符或 PowerShell 里不行。macOS 和 Linux 有原生的一行安装命令。
我可以自己部署,而不是用云服务吗?可以——用 Docker 在本地运行 Plandex,或者把它托管在自己的服务器上并使用自己的密钥。Plandex Cloud 自 2025 年 10 月 3 日起正在逐步停运,不再接受新用户。
它能自己独立运行,还是每次改动都要我批准?两者都行:自主程度可以配置,从完全自动到精细控制都可以。AI 的修改会留在累积的 diff 审查沙盒里,在你应用之前不会动到你的项目文件;命令执行也受到管控,方便你随时回滚。
它可以用哪些 AI 模型?它可以组合使用 Anthropic、OpenAI、Google 以及开源服务商的模型。精选的模型组合在能力、成本和速度上有不同取舍,另外还有针对特定服务商的模型包和开源模型包。
它运行的命令失败了会怎么样?Plandex 会自动调试失败的终端命令,比如构建、代码检查、测试、部署和脚本。如果安装了 Chrome,它还能自动调试浏览器应用。
它和 git 集成吗?是的。它会生成提交信息,还可以选择自动提交。你的项目不必是 git 仓库,但如果是的话,Plandex 能很好地与 git 集成。
What are similar projects?gpt-pilot, Baize, gpt-engineer, open-swe, aider, crush, gsd-2, oh-my-pi
Creator
plandex-ai
Size
55.5 MB
Stars
15.8K
Age
2y
Commits · 90 Days