Open source AI coding agent. Designed for large projects and real world tasks.
Go aiai-agentsai-developer-toolsai-toolsclicommand-linedeveloper-toolsgitgolanggpt-4llmopenaipolyglot-programmingterminalterminal-basedterminal-ui
readme/mardkown guide updates
Dane Schneiderb8caec2a4af7
diff --git a/PRIVACY.md b/PRIVACY.mdindex e69de29b..7b19a32c 100644--- a/PRIVACY.md+++ b/PRIVACY.md@@ -0,0 +1,9 @@+## Plandex privacy and data retention ๐ก๏ธ++Data you send to Plandex Cloud is retained in order to debug and improve Plandex. In the future, this data may also be used to train and fine-tune models to improve performance.++That said, if you delete a plan or delete your account, all associated data will be removed from the database. It will still be included in database backups for up to 7 days, then it will no longer exist anywhere on our servers.++If you self-host Plandex, no data will be sent to Plandex Cloud for any reason.++Data sent to the OpenAI API is subject to OpenAI's privacy policy.diff --git a/README.md b/README.mdindex fd53d05a..78d22791 100644--- a/README.md+++ b/README.md@@ -1,14 +1,14 @@## ๐ Build large features and entire projects with AI.-๐ป Plandex is an open source, terminal-based AI programming engine with long-running agents, automatic file updates, versioning, branches, and diff review.+๐ป Plandex is an open source, terminal-based **AI programming engine** with long-running agents, automatic file updates, versioning, branches, and diff review.-๐ Enables a tight feedback loop between programmer and AI.+๐ Enables a **tight feedback loop** between programmer and AI.-๐ฎ Helps you churn through your backlog, learn new technologies, get unstuck, and spend less time on tedious tasks.+๐ฎ Helps you churn through your backlog, work with unfamiliar technologies, get unstuck, and spend less time on tedious tasks. **Makes programming more fun.**-๐ง Relies on the OpenAI API and requires an `OPENAI_API_KEY` environment variable. Support for Open Source models, Google Gemini, and Anthropic Claude is coming soon.+๐ง Relies on the **OpenAI API** and requires an `OPENAI_API_KEY` environment variable. Support for Open Source models, Google Gemini, and Anthropic Claude is coming soon.-โ Supports Mac and Linux, as well as Windows via [Git bash](https://gitforwindows.org) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/about). Runs from a single binary with no dependencies. Small, fast, and efficient. Works with any programming language or technology.+โ **Supports Mac, Linux, and Windows** (Windows supported via [Git bash](https://gitforwindows.org) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/about)). Runs from a single binary with no dependencies. Small, fast, and efficient. Works with any programming language, framework, or technology.## Install ๐ฅ@@ -18,12 +18,12 @@ curl -s https://plandex.ai/install.sh | bash- ๐๏ธ Go beyond autocomplete to build complex functionality with AI- ๐ซ Stop the mouse-centered, copy-pasting-back-and-forth madness of coding with ChatGPT-- ๐ Manage context efficiently in the terminalโload or remove multiple files or directories in one command with glob patterns-- โก๏ธ Ensure AI models are always working with the latest version of your files+- ๐ Manage context efficiently in the terminalโload or remove entire directories recursively or multiple files with glob patterns+- โก๏ธ Ensure AI models always have the latest versions of files in context- ๐ง Experiment, revise, and review in a protected sandbox before applying changes-- โช Rewind and retry as needed with version control+- โช Rewind and retry as needed with baked-in version control- ๐ฑ Explore multiple approaches with branches-- ๐๏ธ Work on multiple tasks in parallel+- ๐๏ธ Run tasks in the background or work on multiple tasks in parallel- ๐ก๏ธ Try different models and model settings## Get started ๐@@ -56,7 +56,9 @@ plandex [command] --helpPlandex Cloud is the easiest and most reliable way to use Plandex. You'll be prompted to start an anonymous trial (no email required) when you create your first plan with `plandex new`. Anonymous trial accounts are limited to 10 plans and 10 replies per plan. You can upgrade to a full account at any time with a name and email.-Plandex Cloud accounts are free for now. In the future, it will have a monthly fee comparable to other popular AI co-pilot tools.+Plandex Cloud accounts are free for now. In the future, there will be a monthly fee comparable to other popular AI tools.++Plandex Cloud is a bring-your-own-API-key service. We call model providers on your behalf with your API key. You'll need your own account with the model provider. Any API costs incurred with the model provider are your responsibility.## Self-hosting ๐@@ -106,6 +108,9 @@ Please star โญ, fork โ, explore ๐, and contribute ๐ค- [Cursor](https://github.com/getcursor/cursor)- [Github Copilot](https://github.com/features/copilot)- [Replit Ghostwriter](https://replit.com/ai)+- [Grimoire](https://chat.openai.com/g/g-n7Rs0IK86-grimoire)++In my humble and admittedly biased opinion, Plandex is currently more effective for robust end-to-end development than any of these tools. That said, they all have their strengths and are impressive in different ways. All have features that Plandex lacks. I hope to learn from all of them and incorporate as many of their good ideas as possible.## About the developer ๐diff --git a/SECURITY.md b/SECURITY.mdindex a0d37ed4..f4187fe1 100644--- a/SECURITY.md+++ b/SECURITY.md@@ -8,7 +8,7 @@ Plandex respects `.gitignore` and won't load any files that you're ignoring. You#### API key security-Plandex is a bring-your-own-API-key tool. On the server, API keys are only stored ephemerally in RAM while they are in active use. They are never written to disk, logged, or stored in a database.+Plandex is a bring-your-own-API-key tool. On the server, API keys are only stored ephemerally in RAM while they are in active use. They are never written to disk, logged, or stored in a database. As soon as a plan stream ends, the API key is removed from memory and no longer exists anywhere on our servers.It's up to you to manage your API keys securely. Try to avoid storing them in multiple places, exposing them to third party services, or sending them around in plain text. If you'd like some help, please do check out the aforementioned [EnvKey](https://envkey.com). It's open source, end-to-end encrypted, easy to use, and free for up to 3 users. To set your `OPENAI_API_KEY` with EnvKey, you'd add it to an app in the EnvKey UI or CLI, then run `eval $(envkey-source)` in your terminal.