Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plandex-ai/plandex

AI driven development in your terminal. Designed for large, real-world tasks.
https://github.com/plandex-ai/plandex

ai ai-agents ai-developer-tools ai-tools cli command-line developer-tools git golang gpt-4 llm openai polyglot-programming terminal terminal-based terminal-ui

Last synced: 5 days ago
JSON representation

AI driven development in your terminal. Designed for large, real-world tasks.

Awesome Lists containing this project

README 

        


 

  

    

    

    

 

 













  

  

    30-Second Install

  

   · 

  

    Website

  

   · 

  

    Docs

  

   · 

  

    Examples

  

   · 

  

    Self-Hosting

  

   

  








[![Discord](https://img.shields.io/discord/1214825831973785600.svg?style=flat&logo=discord&label=Discord&refresh=1)](https://discord.gg/plandex-ai)

[![GitHub Repo stars](https://img.shields.io/github/stars/plandex-ai/plandex?style=social)](https://github.com/plandex-ai/plandex)

[![Twitter Follow](https://img.shields.io/twitter/follow/PlandexAI?style=social)](https://twitter.com/PlandexAI)








  

PRs Welcome Release

Release



  












plandex-ai%2Fplandex | Trendshift








AI driven development in your terminal.
Build entire features and apps with a robust workflow.












  Plandex intro video











## More examples  🎥



👉  Building Pong in C/OpenGL with GPT-4o and Plandex




👉  Fixing a tricky real-world bug in 5 minutes with Claude Opus 3 and Plandex








## Learn more about Plandex  🧐



- [Overview](#overview-)

- [Install](#install)

- [Get started](#get-started-)

- [Docs](https://docs.plandex.ai/)

- [Build complex software](#build-complex-software-with-llms-)

- [Why Plandex?](#why-plandex-)

- [Roadmap](#roadmap-%EF%B8%8F)

- [Discussion and discord](#discussion-and-discord-)

- [Contributors](#contributors-)





## Overview  📚



Churn through your backlog, work with unfamiliar technologies, get unstuck, and spend less time on the boring stuff.



Plandex is a reliable and developer-friendly AI coding agent in your terminal. It can plan out and complete large tasks that span many files and steps.


 

Designed for real-world use-cases, 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. 







## Install  📥



```bash

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

```



**Note:** Windows is supported via [WSL](https://learn.microsoft.com/en-us/windows/wsl/install). Plandex only works correctly on Windows in the WSL shell. It doesn't work in the Windows CMD prompt or PowerShell.



[More installation options.](https://docs.plandex.ai/install)







## Get started  🚀



Plandex uses OpenAI by default. If you don't have an OpenAI account, first [sign up here.](https://platform.openai.com/signup)



Then [generate an API key here](https://platform.openai.com/account/api-keys) and `export` it.



```bash

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.



```bash

cd your-project-dir

```



Then **start your first plan** with `plandex new`.



```bash

plandex new

```



Load any relevant files, directories, directory layouts, urls, or images **into the LLM's context** with `plandex load`.



```bash

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:



```bash

plandex tell -f prompt.txt

```



Write it in vim:



```bash

plandex tell # tell with no arguments opens vim so you can write your prompt there

```



Or pass it inline (use enter for line breaks):



```bash

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.](https://docs.plandex.ai/quick-start#review-the-changes)**







## Docs  🛠️



### [👉  Full documentation.](https://docs.plandex.ai/)







## 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.







## Why Plandex?  🤔



🏗️  Go beyond autocomplete to build complex functionality with AI.


🚫  Stop the mouse-centered, copy-pasting madness of coding with ChatGPT.


⚡️  Ensure the model always has the latest versions of files in context.


🪙  Retain granular control over what's in the model's context and how many tokens you're using.


⏪  Rewind, iterate, and retry as needed until you get your prompt just right.


🌱  Explore multiple approaches with branches.


🔀  Run tasks in the background or work on multiple tasks in parallel.


🎛️  Try different models and temperatures, then compare results.







## Roadmap  🗺️



🧠  Support for open source models, Google Gemini, and Anthropic Claude in addition to OpenAI  ✅ released


🖼️  Support for multi-modal models—add images and screenshots to context ✅ released


🤝  Plan sharing and team collaboration


🖥️  VSCode and JetBrains extensions


📦  Community plugins and modules


🔌  Github integration


🌐  Web dashboard and GUI


🔐  SOC2 compliance


🛩️  Fine-tuned models



This list will grow and be prioritized based on your feedback.







## Discussion and discord  💬



Speaking of feedback, feel free to give yours, ask questions, report a bug, or just hang out:



- [Discord](https://discord.gg/plandex-ai)

- [Discussions](https://github.com/plandex-ai/plandex/discussions)

- [Issues](https://github.com/plandex-ai/plandex/issues)







## 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.



[Here's an overview on setting up a development environment.](https://docs.plandex.ai/development)