Modus CLI

​

Quick start

npm install -g @getmodus/cli   # the -g is required — without it, `modus` won't be on your PATH

modus login                  # opens your browser to sign in
modus scopes list --pretty   # confirm it worked

​

Authenticate

modus login              # browser-based OAuth (default) — interactive/local use
modus login --no-oauth   # PAT prompt instead — CI/scripts/headless
modus whoami             # confirm the resolved org/token/auth method

• OAuth (default) opens your browser and requests exactly the access your account already has in the Modus web app — nothing more, nothing held back. The access token refreshes automatically; modus logout revokes it server-side.
• CI/scripts: set MODUS_API_KEY — it always overrides the stored credential and is the preferred way to authenticate non-interactively.
• Avoid modus login --token modus_xxx — a token on the command line is readable from shell history, ps, and CI logs.

​

Staging (and other non-prod)

export MODUS_API_KEY='modus_…'   # staging PAT
export MODUS_BASE_URL='https://api.staging.getmodus.com'

modus whoami --pretty
modus scopes list --pretty
modus scopes chat 42 "what can you do?"

modus login --no-oauth --base-url https://api.staging.getmodus.com

​

Output

• Commands that return data print compact JSON by default — pipe it to jq, a script, or an agent.
• Pass --pretty for a human-readable table or summary instead.
• Exception: chat / scopes chat stream raw response text by default; pass --json on those two for structured SSE events instead.

modus scopes list             # {"items":[...],"nextPageToken":null}
modus scopes list --pretty    # aligned table

​

Global flags

• --pretty — human-readable table/summary instead of compact JSON

​

Next steps

• Browse the full CLI command reference (every modus command)
• Python SDK / TypeScript SDK
• API