Skip to content

Installing PlanExe for developers

I assume that you are a python developer.

You need several open terminals to do development on this project.

Clone repo

git clone https://github.com/PlanExeOrg/PlanExe.git

Prepare .env file

Create a .env file from the .env.developer-example file.

Update OPENROUTER_API_KEY with your open router api key.

open_dir_server

In a new terminal: Follow the open_dir_server instructions.

worker_plan

In a new terminal: Follow the worker_plan instructions.

frontend_single_user

In a new terminal: Follow the frontend_single_user instructions.

database_postgres

In a new terminal: Follow the database_postgres instructions.

worker_plan_database

In a new terminal: Follow the worker_plan_database instructions.

frontend_multi_user

In a new terminal: Follow the frontend_multi_user instructions.

Tests

In a new terminal: Run the tests to ensure that the project works correctly.

PROMPT> python test.py
snip lots of output snip
Ran 117 tests in 0.059s

OK

test.py runs in the project venv and now enforces cross-service dependencies for MCP tests. If modules like mcp are missing, it will try to install from: mcp_cloud/requirements.txt. If auto-install fails (for example due network restrictions), install manually in the active venv:

python -m pip install -r mcp_cloud/requirements.txt

Now PlanExe have been installed.