Skip to content

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

readme updates

Dane Schneider940a767c5c72
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 660417db..64958550 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -1,9 +1,10 @@
-## Development
+## Plandex development πŸ› οΈ
To set up a development environment, first install dependencies:
- Go 1.21.3 - [install here](https://go.dev/doc/install)
- [reflex](https://github.com/cespare/reflex) 0.3.1 - for watching files and rebuilding in development. Install with `go install github.com/cespare/[email protected]`
+- PostreSQL 14 -
Then from the root directory, run:
diff --git a/README.md b/README.md
index d709ce1d..8d855de3 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,8 @@
🧠 It 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.
+βœ… It 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).
+
## Install πŸ“₯
curl -s https://plandex.ai/install.sh | bash
@@ -94,6 +96,13 @@ export GOENV=development
Authentication codes will be copied to your clipboard with a system notification instead of being sent by email.
+To use the `plandex` CLI tool with a local server, first set the `PLANDEX_ENV` environment variable to `development` like this:
+
+```bash
+export PLANDEX_ENV=development
+plandex new
+```
+
## Security πŸ”
Plandex 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.