Skip to main content

Self-Hosting

Plandex is open source and uses a client-server architecture. The server can be self-hosted. You can either run it locally or on a cloud server that you control. To run it on a cloud server, go to Advanced Self-Hosting section. To run it locally, keep reading below.

Local Mode Quickstart​

The quickstart requires git, docker, and docker-compose. It's designed for local use with a single user.

  1. Run the server in local mode:
git clone https://github.com/plandex-ai/plandex.git
cd plandex/app
./start_local.sh
  1. In a new terminal session, install the Plandex CLI if you haven't already:
curl -sL https://plandex.ai/install.sh | bash
  1. Run:
plandex sign-in

  1. When prompted 'Use Plandex Cloud or another host?', select 'Local mode host'. Confirm the default host, which is http://localhost:8099.

  2. Decide on the model provider(s) you want to use. The quickest option is to use OpenRouter.ai, but you can also use many other providers.

If you're using OpenRouter.ai, first sign up here. Then generate an API key here. Set the OPENROUTER_API_KEY environment variable:

export OPENROUTER_API_KEY=...
  1. In a project directory, start the Plandex REPL:
plandex

You're ready to start building!

Upgrade​

To upgrade after a new release, just use ctrl-c to stop the server, then run the script again:

./start_local.sh

The script will pull the latest image before the server starts.