Skip to content

Open source AI coding agent. Designed for large projects and real world tasks.

readme/mardkown guide updates

Dane Schneiderfd2cdaf0a559
diff --git a/PRIVACY.md b/PRIVACY.md
index 7b19a32c..4a9a8cfa 100644
--- a/PRIVACY.md
+++ b/PRIVACY.md
@@ -4,6 +4,6 @@ Data you send to Plandex Cloud is retained in order to debug and improve Plandex
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.
+If you self-host Plandex, no data will be sent to Plandex Cloud.
-Data sent to the OpenAI API is subject to OpenAI's privacy policy.
+Data sent to a model provider like OpenAI is subject to the model provider's privacy and data retention policies.
diff --git a/README.md b/README.md
index 99b3528d..662dd47f 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
## ๐ŸŒŸ Build large features and entire projects with AI.
-๐Ÿ’ป Plandex is a 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.
-๐Ÿ”ฎ Helps you churn through your backlog, work with unfamiliar technologies, get unstuck, and spend less time on tedious tasks. **Makes programming more fun.**
+๐Ÿ‹๏ธ 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.
@@ -14,31 +14,20 @@
curl -s https://plandex.ai/install.sh | bash
-## Why Plandex? ๐Ÿค”
-
-- ๐Ÿ—๏ธ 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 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 baked-in version control
-- ๐ŸŒฑ Explore multiple approaches with branches
-- ๐ŸŽ๏ธ Run tasks in the background or work on multiple tasks in parallel
-- ๐ŸŒก๏ธ Try different models and model settings
-
## Get started ๐Ÿš€
```
+export OPENAI_API_KEY=...
plandex new
```
-To type a bit less, you can use the `pdx` alias instead of `plandex` if you like:
+You can also use the `pdx` alias instead of `plandex` if you like:
```
pdx new
```
-After any plandex command is run, additional commands that may make sense to run next will be suggested.
+After any plandex command is run, additional commands that could make sense to run next will be suggested.
To see all available commands, run:
@@ -52,13 +41,29 @@ For help on any command, run:
plandex [command] --help
```
+## Why Plandex? ๐Ÿค”
+
+- ๐Ÿ—๏ธ 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 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 baked-in version control
+- ๐ŸŒฑ Explore multiple approaches with branches
+- ๐ŸŽ๏ธ Run tasks in the background or work on multiple tasks in parallel
+- ๐ŸŒก๏ธ Try different models and model settings
+
+## License ๐Ÿ“œ
+
+Plandex is open source under the MIT License.
+
## Plandex Cloud โ˜๏ธ
-Plandex 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 your name and email.
+Plandex 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`. Trial accounts are limited to 10 plans and 10 replies per plan. You can upgrade to a full account at any time with your name and email.
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.
+Plandex Cloud is a bring-your-own-API-key service. We call model providers like OpenAI 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 while using Plandex are your responsibility.
## Self-hosting ๐Ÿ 
@@ -110,7 +115,7 @@ Please star โญ, fork โ‘‚, explore ๐Ÿ”, and contribute ๐Ÿค
- [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.
+In my humble and 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 ๐Ÿ‘‹
@@ -120,7 +125,7 @@ I live with my wife and 4 year old daughter on the SF peninsula in California. I
## Possible co-founder? ๐Ÿ˜Ž
-I'm looking for a technical co-founder or two with Golang/Devops/TypeScript experience to help me get Plandex off the ground as an open source project, a product, and a fun, WFH-friendly company. If you're interested, please reach out or jump in and start contributing.
+I'm looking for a technical co-founder or two with experience in some combination of Golang|Devops|TypeScript|AI to help me get Plandex off the ground as an open source project, a product, and a fun, WFH-friendly company. If you're interested, please reach out or jump in and start contributing.
## Possible employee? ๐Ÿ‘ฉโ€๐Ÿ’ป