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; при первом запуске он сам предложит её подключить.
Насколько большой проект он реально потянет?Он напрямую работает с контекстом до 2 млн токенов (примерно 100 тысяч на файл) и индексирует каталоги на 20+ млн токенов с помощью карт проекта на tree-sitter, а также проверяет синтаксис более чем для 30 языков.
Работает ли он на Windows?Только через WSL — Plandex корректно работает в оболочке WSL, но не в командной строке Windows CMD и не в PowerShell. На macOS и Linux есть нативная установка одной командой.
Могу ли я разместить его у себя, а не пользоваться облачным сервисом?Да — запустите Plandex локально через Docker или разверните на своём сервере со своими ключами. Plandex Cloud закрывается с 10/3/2025 и больше не принимает новых пользователей.
Он может работать сам или мне нужно подтверждать каждое изменение?И так, и так: уровень автономности настраивается от полного автопилота до детального контроля. Правки ИИ остаются в песочнице с накопительным diff-обзором, отдельно от файлов проекта, пока вы их не примените, а выполнение команд контролируется, чтобы можно было всё откатить.
Какие AI-модели можно с ним использовать?Он умеет комбинировать модели от Anthropic, OpenAI, Google и провайдеров open source. Готовые наборы моделей предлагают разный баланс возможностей, стоимости и скорости, плюс есть наборы для конкретных провайдеров и open source.
Что будет, если команда, которую он запустил, завершится с ошибкой?Plandex автоматически отлаживает упавшие команды в терминале — сборки, линтеры, тесты, деплой и скрипты. Если установлен Chrome, он также может автоматически отлаживать браузерные приложения.
Он интегрируется с git?Да. Он создаёт сообщения коммитов и при желании может коммитить автоматически. Ваш проект не обязан быть git-репозиторием, но если это так, Plandex хорошо с ним интегрируется.
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