Quickstart
Install
Section titled “Install”Homebrew (macOS/Linux)
Section titled “Homebrew (macOS/Linux)”brew tap respawn-app/tapbrew install builder-cliStandalone binaries via GitHub Releases
Section titled “Standalone binaries via GitHub Releases”These versions are not auto-updated. Please keep them updated manually.
curl -fsSL https://raw.githubusercontent.com/respawn-app/builder/main/scripts/install.sh | shCheck the installed version with: builder --version
First Authentication
Section titled “First Authentication”Start Builder CLI with: builder
Supported auth options:
- OpenAI/Codex subscription OAuth via the startup sign-in picker.
- OpenAI API-key auth via
OPENAI_API_KEY. If you prefer API-key auth, exportOPENAI_API_KEYbefore launch and builder will use it with your permission.
You can switch later with /logout.
Main Workflows
Section titled “Main Workflows”- Press
F1to invoke help with hotkeys. - Use
Enterto steer the model,Tabto queue messages. - Use
Shift+Tabto toggle between detailed transcript mode and ongoing mode. - Type
$ <command>to execute a shell command and show its output to the model. - Press
Esctwice to enter Edit mode, which lets you go back in time, edit a previous message, and fork the session into a new one. File edits stay. - Use the
Up/Downarrow keys to select and resend previous prompts. - Press
Ctrl+VorCtrl+Dto paste a clipboard screenshot into the prompt as an image file path. - Use
/reviewto start a code review. In a non-empty session, Builder opens that review in a fresh child session. After the review finishes, you can use/backto teleport to the original session. /namewill set your session name in the picker and terminal title./autocompactionwill toggle compaction, and/compactwill trigger one. If autocompact is off, you can go above 100% context usage if model allows it. Going above 100% will incur additional costs.- Run
/statusto get detailed info about the session.
For the full command reference, see Slash Commands.
Configuration
Section titled “Configuration”Builder reads settings from ~/.builder/config.toml and will auto-create it through a UI flow on first start. The full reference is on the Configuration page.
Skills And Custom Commands
Section titled “Skills And Custom Commands”Builder discovers skills from:
~/.builder/skills<workspace>/.builder/skills
You can set up skills during the onboarding flow.
Builder discovers custom slash commands from Markdown files in:
<workspace>/.builder/prompts<workspace>/.builder/commands~/.builder/prompts~/.builder/commands
Each top-level .md file becomes a /prompt:<name> command.
You can disable individual skills for new sessions in ~/.builder/config.toml:
[skills]apiresult = falseChanges will take effect when you start a new sesssion.
Supervisor
Section titled “Supervisor”- Use
/supervisorto toggle supervisor invocation for the current session. Initial value is config’sreviewer.frequency, and default is on. Supervisor is a feature that will automatically review the edits made by the model. It increases costs by ~20% but improves results.
By default supervisor uses the same model as the main one. That may be too much / too slow for you. Configuration page contains instructions on how to change supervisor model.
Running OSS models or smaller models like gpt5.4-mini seems to give good results while keeping costs low.