Install and configure the CLI

Updated 12 October 2026

Reviewed against Console v0.2.2. Available actions depend on project access and runtime configuration; check your installed CLI version for command differences.

Install or update with uv (recommended)#

Install uv first. Stimulir requires Python 3.11 or newer. uv keeps the CLI in its own environment and makes the command available from any directory for your user account. It does not install the SDK into your application.

Choose the install scope: uv tool install gives your user account a CLI available across projects. For an SDK dependency in a uv-managed project, run uv add stimulir in that project instead. Neither uv nor pip uses npm’s -g flag; user-wide CLI installation and project dependencies are separate.

uv tool install --upgrade stimulir
stimulir --version
stimulir --help

Use this command for both a first install and an update. --upgrade checks for newer compatible packages on your configured index, which is PyPI by default. A plain uv tool install stimulir can keep an existing installation; stimulir --version only reports the command’s installed version.

Update an existing uv installation#

uv tool upgrade stimulir
stimulir --version

This updates a tool already installed with uv. Upgrades respect any version constraints used at installation; rerun the unpinned install command above to replace a previous version pin. Check the published releases when comparing versions. Updates happen when you run the command, not automatically.

Alternative: install or update with pip#

For a user-level command on macOS or Linux, use Python 3.11 or newer outside a virtual environment. This requires a Python installation that permits user packages:

python3 -m pip install --upgrade --user stimulir
stimulir --version

On Windows, use py -m pip instead of python3 -m pip. Add the scripts directory reported by pip to PATH if the command is not found. If Python reports an externally-managed-environment, use the uv installation above or a virtual environment; do not override the system package protections.

Inside an activated virtual environment, omit --user and install into that environment:

python -m pip install --upgrade stimulir
stimulir --version

The virtual-environment command is available while that environment is active. Choose one installer for the CLI so you do not accidentally run an older copy installed elsewhere. Both uv and pip select versions compatible with your Python and configured constraints.

Check PATH and the installed command#

If stimulir is not found after a uv install, add uv’s executable directory to your shell, then open a new terminal:

uv tool update-shell

If the version still looks old, run command -v stimulir on macOS/Linux or Get-Command stimulir in PowerShell to see which executable wins on PATH. Compare it with uv tool dir --bin for a uv install. An active project environment can take precedence over your user-level CLI.

Check stimulir --version and stimulir --help after updating. For installer details, see the official uv tools guide and pip install reference.

Sign in#

stimulir login
stimulir whoami

Complete the browser flow yourself and verify the returned account. Keep generated credentials out of shell history and source control.

Select workspace and project#

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

Use IDs returned by the list commands. Application code normally uses its own hyb_* key and project context instead of depending on your interactive login.

Configure a project or explore commands#

stimulir setup can configure a project’s coding-agent integration and environment. It can create a key, write local configuration and send a test request. Review those choices; use its --no-test option when you only want configuration.

Continue to the command reference, interactive agent or Python SDK.

Command catalogue#

Expand a command for its arguments. These commands follow the released CLI source; check stimulir --version and the command’s --help for your installation. Required flags are marked; some operations also validate combinations of inputs.