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

Log in with your Stimulir account email and password. The session token is stored in ~/.stimulir/:

bash
stimulir login

Select a workspace

Commands operate against your active workspace. Pick one after logging in:

bash
stimulir workspace list
stimulir workspace use <workspace-id>

The active workspace selection is persisted alongside your token in ~/.stimulir/. Switch any time with stimulir workspace use.

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.