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)

gpt-4
Searching Database…

15.7K ·GitHub
What is this?Plandex is an open source AI coding agent that runs in the terminal. It plans and executes large coding tasks spanning many steps and dozens of files, built for real-world projects.
How do I get it running?Install the CLI with a one-line, zero-dependency command, then just run plandex in any project directory to start the REPL. A Dockerized local mode lets you self-host the server.
Do I need my own API keys or accounts to use it?Yes — Plandex uses your own provider accounts and API keys, like an OpenRouter.ai key. A Claude Pro or Max subscription can also power Anthropic models; it offers to connect it on first run.
How big a project can it actually handle?It handles up to 2M tokens of context directly (about 100k per file) and indexes directories of 20M+ tokens with tree-sitter project maps, with syntax validation for 30+ languages.
Does it work on Windows?Only through WSL — Plandex works correctly in the WSL shell but not in the Windows CMD prompt or PowerShell. macOS and Linux get a native one-line install.
Can I host it myself instead of using a cloud service?Yes — run Plandex locally with Docker or host it on your own server with your own keys. Plandex Cloud is winding down as of 10/3/2025 and no longer accepts new users.
Can it run on its own, or do I approve every change?Both: autonomy is configurable from full auto to fine-grained control. AI edits stay in a cumulative diff review sandbox, separate from your project files until you apply them, and command execution is controlled so you can roll back.
Which AI models can I use with it?It can combine models from Anthropic, OpenAI, Google, and open source providers. Curated model packs offer different tradeoffs of capability, cost, and speed, plus provider-specific and open source packs.
What happens when a command it runs fails?Plandex automatically debugs failed terminal commands like builds, linters, tests, deployments, and scripts. If Chrome is installed, it can also automatically debug browser applications.
Does it integrate with git?Yes. It generates commit messages and can optionally commit automatically. Your project does not have to be in a git repo, but Plandex integrates well if it is.
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.7K
Age
2y
Commits · 90 Days