CLI

Installation

Install the stimulir CLI and connect it to your account.

Install

Install with uv as an isolated tool, no virtualenv management needed:

bash
uv tool install stimulir

Or run it without installing:

bash
uvx stimulir --help

Verify the install and upgrade later with:

bash
stimulir --help
uv tool upgrade stimulir

Log in

Logging in opens a browser device authorization, no password is typed in the terminal. stimulir login prints a link and a short code; you approve in the console, and the CLI receives a revocable session token stored in ~/.stimulir/:

bash
stimulir login

The CLI prints a link to console.stimulir.com/cli and a short code (e.g. ABCD-1234). Open the link in a signed-in browser, confirm the code matches, and approve, the CLI then receives a 30-day, revocable session token. Re-run stimulir login any time to rotate it.

Bare stimulir (when logged out) offers to run this same flow inline before starting the agent. Already have a token from the console? stimulir login --token <token> pastes it directly. Revoke a machine's token with stimulir logout --remote.

Switching workspaces

Login already selects your workspace, the CLI persists it alongside your token in ~/.stimulir/, and inference keys carry their own scope, so there is no workspace id to copy. If you belong to more than one workspace, switch the active one any time:

bash
stimulir workspace list   # the active workspace is marked
stimulir workspace use <id>

Next

Browse the full Command Reference, use the Python SDK from application code, or jump straight to the Quickstart for an end-to-end walkthrough.