Quickstart
Install Plandex
curl -sL https://plandex.ai/install.sh | bash
Click here for more installation options.
Note that Windows is supported via WSL. Plandex only works correctly on Windows in the WSL shell. It doesn't work in the Windows CMD prompt or PowerShell.
Hosting Options
| Option | Description |
|---|---|
| Plandex Cloud (Integrated Models) | • No separate accounts or API keys. • Easy multi-device usage. • Centralized billing, budgeting, usage tracking, and cost reporting. • Quickest way to get started. |
| Plandex Cloud (BYO API Key) | • Use Plandex Cloud with your own OpenRouter.ai and OpenAI keys. |
| Self-hosted/Local Mode | • Run Plandex locally with Docker or host on your own server. • Use your own OpenRouter.ai and OpenAI keys. • Follow the local-mode quickstart to get started. |
If you're going with a 'BYO API Key' option above (whether cloud or self-hosted), you'll need to set the OPENROUTER_API_KEY and OPENAI_API_KEY environment variables before continuing:
export OPENROUTER_API_KEY=...
export OPENAI_API_KEY=...
Get Started
If you're starting on a new project, make a directory first:
mkdir your-project-dir
Now cd into your project's directory.
cd your-project-dir
Then just give a quick the REPL help text a quick read, and you're ready go. The REPL starts in chat mode by default, which is good for fleshing out ideas before moving to implementation. Once the task is clear, Plandex will prompt you to switch to tell mode to make a detailed plan and start writing code.
plandex
or for short:
pdx
☁️ If you're using Plandex Cloud, you'll be prompted at this point to start a trial.
Then just give the REPL help text a quick read, and you're ready go.