Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.46 KB

DEVELOPMENT.md

File metadata and controls

42 lines (27 loc) · 1.46 KB

Plandex development 🛠️

To set up a development environment, first install dependencies:

Make sure $GOPATH is in your $PATH

# print $GOPATH
echo $GOPATH

# if it's empty
export GOPATH=<path-to-go-folder>

Make sure the PostgreSQL server is running and create a database called plandex.

Then make sure the following environment variables are set:

export DATABASE_URL=postgres://user:password@host:5432/plandex?sslmode=disable # replace with your own database URL
export GOENV=development

Note: EnvKey is a good way to manage environment variables in development.

Now from the root directory of this repo, run:

./dev.sh

This creates watchers with reflex to rebuild both the server and the CLI when relevant files change.

The server runs on port 8080 by default.

After each build, the CLI is copied to /usr/local/bin/plandex (which can also be changed with the environment variable PLANDEX_OUT_DIR) so you can use it with just plandex in any directory. A pdx alias is also created.

When running the Plandex CLI, set export PLANDEX_ENV=development to run in development mode, which connects to the development server by default.