headroomlabs-ai / headroom
Get started
Taken from the repository's own files on 23 Oct 2026. RepoPilot has not run these commands.
Prerequisites
Python >=3.10from pyproject.toml
Commands
Makefile| Task | Run | What it runs |
|---|---|---|
| test | make test | $(CARGO) test --workspace |
No installation or usage section was found in the README. Read the README
Developing
CONTRIBUTING.mdgit clone https://github.com/headroomlabs-ai/headroom.git
cd headroom
python -m venv .venv && source .venv/bin/activate
node --version # Node 18+ required for commitlint hooks
python -m pip install --upgrade pip
python -m pip install -e ".[dev,relevance,proxy]"
python -m pytest
Headroom uses a pyproject.toml/maturin build backend. Older pip
versions may fail editable installs by looking for setup.py; upgrade pip
first or use uv sync --extra dev.
Dev Containers
Two configs ship for VS Code / Codespaces:
.devcontainer/devcontainer.json— Python 3.12,uv, Node.js,gh..devcontainer/memory-stack/devcontainer.json— adds Qdrant + Neo4j sidecars (useqdrant:6333,neo4j://neo4j:7687).
Inside, use: uv run ruff check ., uv run pytest, etc.