Clone and install
Install Python 3.13+, uv, Bun, and Docker with Compose. Clone the repository and install its dependencies:AIRMUX_DEV_POSTGRES_PORT to a free port when starting Compose and export DATABASE_URL with that port in shells that
run control-plane commands. For example:
Start the development environment
Migrate the fresh database, then load the development catalog:http://127.0.0.1:8000):
http://127.0.0.1:8080):
http://127.0.0.1:5000):
.airmux/dataplane.key when needed. Keep that key with its local database.
Develop and verify
Create a branch for your change. Add a behavior test, make the change, and run the checks for the affected area. For a full local check:uv run pytest apps/control-plane/tests/unit. Integration tests use the Postgres service started above. For inference request-path changes, run uv run pytest tests/acceptance/full_stack/scenarios and verify a real request through the local gateway.
Contribute a change
Before editing, read CONTRIBUTING.md,AGENTS.md, and any relevant design record. Update generated contracts when their source changes, and commit generated outputs with the change.
Open a pull request against main with a concise summary of user impact and the checks you ran. Draft and ready pull requests run the same fast checks. CI - Main runs the broader checks after merge. Address review feedback and merge after the required CI and security checks pass.