Quick Start¶

Install¶

First, install uv (if you don't have it):

macOS / Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Then install Obra:

uv tool install obra

For voice dictation in Studio, add the voice extra:

uv tool install obra --with 'obra[voice]'

For most users, obra studio is the normal entrypoint:

obra studio

This command checks readiness, starts or reuses the local gateway, and opens the packaged Studio UI in your browser.

If Studio is not ready yet, diagnose it with:

obra studio doctor
obra studio doctor --fix

Use the gateway directly when you are integrating against the HTTP or WebSocket API yourself:

obra gateway start

The canonical API surface is documented in Gateway API.

obra setup
obra login
obra --help