Quick Start

Four steps from nothing to a live agent on your phone. Total time is about a minute, most of which is your camera focusing on a QR code.

1. Install

codeout ships as a single global package. Install it with bun.

terminal
$ bun install -g codeoutcli

That puts the codeout command on your path. The full list of requirements and the update routine live on the Install page if you want them.

2. Run the daemon

From the project directory you want to work in, start the daemon. It prints a local URL and a pairing QR right there in the terminal.

~/projects/app
$ codeout
codeout -> http://localhost:8400
pair a device: scan the QR, or type this code
  K7QM-3FBR-9TZX
  expires in 5:00
  ████  ███  █████
  █  █  ████  █   █
  ████  █  █  ████

The daemon now holds the listener open and waits for a device. Leave this running. Everything you do happens inside this process.

3. Pair a device

Open your phone camera or the codeout app and point it at the QR. It carries the daemon address and a single-use pairing secret. Your device runs a key exchange, gets its own device token, and is paired. You do not type a password anywhere.

No camera handy? Type the printed code (K7QM-3FBR-9TZX) into the app along with the daemon address. Same key exchange, same result. After connecting, the app shows a short daemon fingerprint; glance at it and confirm it matches the one in your terminal. The full story, including why that fingerprint matters, is on the Pairing a device page.

4. Open a session

In the codeout UI, create a session and choose its agent.

claude
starts the Claude agent in the current project
gemini
starts the Gemini agent in the current project
shell
a plain interactive shell, no agent

Type as you would in any terminal. The session keeps running on the daemon, so you can close the tab, walk away, and pick it back up from a different device with everything intact. That is the whole loop.

Next steps

Tip

Want it reachable when you leave the house? See Remote access for the Tailscale path and the one-command tunnel. Running several agents at once? That is Managing sessions.