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
Update README.md
Dane Schneiderc7ea96a7c9b4
diff --git a/README.md b/README.mdindex e69de29b..c0c7d9b3 100644--- a/README.md+++ b/README.md@@ -0,0 +1,37 @@+# Plandex++Iterative development with AI.++## 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]`++## Development++From the root directory, run:++```bash+export OPEN_AI_API_KEY=...+./dev.sh+```++This creates watchers with `reflex` to rebuild both the server and the CLI when relevant files change.++The server runs on port 8088 by default.++After each build, the CLI is copied to `/usr/local/bin/plandex` so you can use it with just `plandex` in any directory. A `pdx` alias is also created.++## Usage++To start on a new plan, run:++```+plandex new+```++To see all available commands, run:++```+plandex help+```