| tags |
|
|---|
This setup uses these tools:
OpenCodeas the coding agentMTPLXas the local OpenAI-compatible model serverHeadroomas an optional proxy in front ofMTPLXDockerto runHeadroomwithout a separate Python install
- OpenCode home: https://opencode.ai
- OpenCode docs: https://opencode.ai/docs
- OpenCode config docs: https://opencode.ai/docs/config
- OpenCode GitHub: https://github.com/anomalyco/opencode
- MTPLX homepage: https://mtplx.com
- MTPLX download page: https://mtplx.com/download
- MTPLX releases: https://mtplx.com/releases
- MTPLX PyPI: https://pypi.org/project/mtplx/
- MTPLX GitHub: https://github.com/youssofal/MTPLX
- Headroom GitHub: https://github.com/headroomlabs-ai/headroom
- Headroom docs: https://headroom-docs.vercel.app/docs
- Docker: https://www.docker.com/products/docker-desktop/
Recommended options:
- Install script:
curl -fsSL https://opencode.ai/install | bash- Homebrew:
brew install anomalyco/tap/opencode- npm:
npm install -g opencode-aiMTPLX ships as both a macOS native app (with a GUI) and a CLI — you can use either.
macOS app (GUI):
- The app provides the same functionality as the CLI in a native window.
- A
.dmgis attached to every GitHub release. - Also available from mtplx.com.
CLI (recommended for automation / OpenCode integration):
-
Homebrew:
brew install youssofal/mtplx/mtplx
-
pip:
python3 -m pip install mtplx
Notes:
MTPLXrequires Apple Silicon and macOS.MTPLXexposes an OpenAI-compatible API thatOpenCodecan use directly.
Recommended options:
- Docker image:
docker pull ghcr.io/chopratejas/headroom:latest- Python package:
pip install "headroom-ai[all]"- npm package:
npm install headroom-aiFor this setup, the Docker image is the simplest option.
Install Docker Desktop on macOS from:
This is needed if Headroom is run as a container.
Minimum setup:
- Install
OpenCode - Install
MTPLX - Install
Docker Desktop - Optionally install
Headroomthrough Docker only
{ "$schema": "https://opencode.ai/config.json", "provider": { "mtplx": { "npm": "@ai-sdk/openai-compatible", "name": "MTPLX (local)", "options": { "baseURL": "http://127.0.0.1:8000/v1" }, "models": { "mtplx": { "name": "MTPLX" } } }, "mtplx-headroom": { "npm": "@ai-sdk/openai-compatible", "name": "MTPLX-Headroom", "options": { "baseURL": "http://127.0.0.1:8787/v1" }, "models": { "mtplx": { "name": "MTPLX" } } } } }