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 updates
Dane Schneider930fca3cbf11
diff --git a/README.md b/README.mdindex 82edee06..4b1e4dac 100644--- a/README.md+++ b/README.md@@ -60,7 +60,7 @@ Plandex Cloud accounts are free for now. In the future, it will have a monthly f## Self-hosting 🏠-### Anywhere+#### AnywhereThe Plandex server runs from a Dockerfile at `app/Dockerfile.server`. It requires a PostgreSQL database and these environment variables:@@ -71,7 +71,7 @@ export GOENV=productionAuthentication emails are sent through AWS SES, so you'll need an AWS account with SES enabled. You'll be able to sub in SMTP credentials in the future (PRs welcome).-### AWS+#### AWSRun `./infra/deploy.sh` to deploy a production-ready Cloudformation stack to AWS.@@ -85,7 +85,7 @@ NOTIFY_SMS=country-code-plus-full-number # e.g. +14155552671 | for urgent AWS alCERTIFICATE_ARN=your-aws-cert-manager-arn # for HTTPS -- must be a valid certificate in AWS Certificate Manager in the same region```-### Locally+#### LocallyTo run the Plandex server locally, run it in development mode with `./dev.sh`. You'll need a PostgreSQL database running locally as well as these environment variables:@@ -107,17 +107,17 @@ plandex newPlandex follows best practices for network and data security. As I'm also the founder of a devops-security company ([EnvKey](https://envkey.com)), this is an area I have experience in and take extremely seriously. Data is encrypted in transit and at rest. The database runs within a private, hardened network.-### Ignore sensitive files+#### Ignores sensitive filesPlandex respects `.gitignore` and won't load any files that you're ignoring. You can also add a `.plandexignore` file with ignore patterns to any directory.-### API key security+#### API key securityPlandex 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.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.-### Third party services+#### Third party servicesPlandex Cloud relies on AWS for all database and hosting services, Github for code storage, and the OpenAI API for AI models. No other third party services are used.