Full reference
Authentication and project context
Keep interactive account access separate from application credentials. A Stimulir application key supplies workspace scope; project attribution identifies the workflow’s project.
Updated
Reviewed against Console v0.2.2. Available actions depend on project access and runtime configuration; check your installed CLI version for command differences.
Match Console and application scope
Check organisation and project in the Console top bar. Find the project ID in Settings → Project → General and manage application credentials in Settings → Project → API keys. Keep the project parameter when sharing an existing Console link. A working key and a selected Console project can still refer to different request attribution; verify the resulting trace.
Choose the credential for the task
| Credential | Use | Keep it |
|---|---|---|
| CLI login | Interactive workspace administration and account-scoped commands | In the CLI credential store |
| hyb_* application key | Application inference and permitted SDK operations | In application secrets or environment variables |
| Provider credential | Upstream provider access configured through BYOK | In the BYOK credential store |
| Runtime credential | A separately configured runtime, when required | According to the runtime operator’s policy |
Sign in for interactive work
stimulir login
stimulir whoami
stimulir workspace list
stimulir project listUse the browser login flow and verify the active account. stimulir logout removes the saved CLI session. Select the intended workspace before creating or changing a credential.
Authenticate an application
STIMULIR_API_BASE=https://api.stimulir.com
STIMULIR_API_KEY=hyb_...
STIMULIR_PROJECT_ID=...Send the application key as Authorization: Bearer …. Set X-Project-Id for project attribution; the SDK supplies it from project_id or STIMULIR_PROJECT_ID. An application key already carries its workspace scope. Do not copy a browser session token into an application.
Resolve scope errors
A successful login does not prove that a key has access to a particular project or operation. Check the selected environment, workspace, project and credential status. Rotate a compromised key, update applications, verify their requests, then revoke the old key. See API keys and BYOK.
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.
stimulir project clear
Clear the active project — attribute at the workspace level again.
No command-specific arguments.
stimulir project list
List projects in the active workspace (the active one is marked).
--json- Emit raw JSON output.
stimulir project use
Set the active project (sent as X-Project-Id, saved to ~/.stimulir/config.json).
project_idrequired- Positional argument. Project id to attribute requests to.
stimulir workspace list
List workspaces you belong to (the active one is marked).
--json- Emit raw JSON output.
stimulir workspace use
Set the active workspace (saved to ~/.stimulir/config.json).
workspace_idrequired- Positional argument. Workspace (business profile) id.