Awesome
<h1 align="center"> <a href="https://plandex.ai"> <picture> <source media="(prefers-color-scheme: dark)" srcset="images/plandex-logo-dark.png"/> <source media="(prefers-color-scheme: light)" srcset="images/plandex-logo-light.png"/> <img width="400" src="images/plandex-logo-dark-bg.png"/> </a> <br /> </h1> <br /> <div align="center"> <p align="center"> <!-- Call to Action Links --> <a href="#install"> <b>30-Second Install</b> </a> · <a href="https://plandex.ai"> <b>Website</b> </a> · <a href="https://docs.plandex.ai/"> <b>Docs</b> </a> · <a href="#more-examples-"> <b>Examples</b> </a> · <a href="https://docs.plandex.ai/hosting/self-hosting"> <b>Self-Hosting</b> </a> <!-- · <a href="./guides/DEVELOPMENT.md"> <b>Development</b> </a> --> <!-- · <a href="https://discord.gg/plandex-ai"> <b>Discord</b> </a> · <a href="#weekly-office-hours-"> <b>Office Hours</b> </a> --> </p> <br>
More examples 🎥
<h4>👉 <a href="https://www.youtube.com/watch?v=0ULjQx25S_Y">Building Pong in C/OpenGL with GPT-4o and Plandex</a></h4> <h4>👉 <a href="https://www.youtube.com/watch?v=rnlepfh7TN4">Fixing a tricky real-world bug in 5 minutes with Claude Opus 3 and Plandex</a></h4> <br/>Learn more about Plandex 🧐
- Overview
- Install
- Get started
- Docs
- Build complex software
- Why Plandex?
- Roadmap
- Discussion and discord
- Contributors <br/>
Overview 📚
<p>Churn through your backlog, work with unfamiliar technologies, get unstuck, and <strong>spend less time on the boring stuff.</strong></p> <p>Plandex is a <strong>reliable and developer-friendly</strong> AI coding agent in your terminal. It can plan out and complete <strong>large tasks</strong> that span many files and steps.</p> <p>Designed for <strong>real-world use-cases</strong>, Plandex can help you build a new app quickly, add new features to an existing codebase, write tests and scripts, understand code, and fix bugs. </p> <br/>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.
<br/>Get started 🚀
Plandex uses OpenAI by default. If you don't have an OpenAI account, first sign up here.
Then generate an API key here and export it.
export OPENAI_API_KEY=...
Now cd into your project's directory. Make a new directory first with mkdir your-project-dir if you're starting on a new project.
cd your-project-dir
Then start your first plan with plandex new.
plandex new
Load any relevant files, directories, directory layouts, urls, or images into the LLM's context with plandex load.
plandex load some-file.ts another-file.ts
plandex load src/components -r # load a whole directory
plandex load src --tree # load a directory layout (file names only)
plandex load src/**/*.ts # load files matching a glob pattern
plandex load https://raw.githubusercontent.com/plandex-ai/plandex/main/README.md # load the text content of a url
plandex load images/mockup.png # load an image
Now send your prompt. You can pass it in as a file:
plandex tell -f prompt.txt
Write it in vim:
plandex tell # tell with no arguments opens vim so you can write your prompt there
Or pass it inline (use enter for line breaks):
plandex tell "add a new line chart showing the number of foobars over time to components/charts.tsx"
Plandex will make a plan for your task and then implement that plan in code. The changes won't yet be applied to your project files. Instead, they'll accumulate in Plandex's sandbox.
To learn about reviewing changes, iterating on the plan, and applying changes to your project, continue with the full quickstart.
<br/>Docs 🛠️
👉 Full documentation.
<br/>Build complex software with LLMs 🌟
⚡️ Changes are accumulated in a protected sandbox so that you can review them before automatically applying them to your project files. Built-in version control allows you to easily go backwards and try a different approach. Branches allow you to try multiple approaches and compare the results.
📑 Manage context efficiently in the terminal. Easily add files or entire directories to context, and keep them updated automatically as you work so that models always have the latest state of your project.
🧠 By default, Plandex relies on the OpenAI API and requires an OPENAI_API_KEY environment variable. You can also use it with a wide range of other models, including Anthropic Claude, Google Gemini, Mixtral, Llama and many more via OpenRouter.ai, Together.ai, or any other OpenAI-compatible provider.
✅ Plandex supports Mac, Linux, FreeBSD, and Windows. It runs from a single binary with no dependencies.
<br/>Why Plandex? 🤔
🏗️ Go beyond autocomplete to build complex functionality with AI.<br> 🚫 Stop the mouse-centered, copy-pasting madness of coding with ChatGPT.<br> ⚡️ Ensure the model always has the latest versions of files in context.<br> 🪙 Retain granular control over what's in the model's context and how many tokens you're using.<br> ⏪ Rewind, iterate, and retry as needed until you get your prompt just right.<br> 🌱 Explore multiple approaches with branches.<br> 🔀 Run tasks in the background or work on multiple tasks in parallel.<br> 🎛️ Try different models and temperatures, then compare results.<br>
<br/>Roadmap 🗺️
🧠 Support for open source models, Google Gemini, and Anthropic Claude in addition to OpenAI ✅ released<br> 🖼️ Support for multi-modal models—add images and screenshots to context ✅ released<br> 🤝 Plan sharing and team collaboration<br> 🖥️ VSCode and JetBrains extensions<br> 📦 Community plugins and modules<br> 🔌 Github integration<br> 🌐 Web dashboard and GUI<br> 🔐 SOC2 compliance<br> 🛩️ Fine-tuned models<br>
This list will grow and be prioritized based on your feedback.
<br/>Discussion and discord 💬
Speaking of feedback, feel free to give yours, ask questions, report a bug, or just hang out:
<br/>Contributors 👥
⭐️ Please star, fork, explore, and contribute to Plandex. There's a lot of work to do and so much that can be improved.
Work on tests, evals, prompts, and bug fixes is especially appreciated.