Onus CLI Quickstart

The official command line and TypeScript SDK for Onus — generated from the public OpenAPI spec, equally useful to humans and AI coding agents.

Install the CLI

Install globally from npm, or run it ad hoc with npx — no install required:

Global install

npm i -g @brunyee-studio/onus-cli@latest

Run without installing

npx onus --help

Log in

Authenticate interactively via browser OAuth — the CLI opens your browser and catches the callback on a local loopback port:

onus auth login

For headless environments (CI, agents) pass an access token directly:

onus auth login --token <your-onus-token>

Verify you are authenticated:

onus auth status

Install the agent skill

The package bundles an @brunyee-studio/onus-cli skill that teaches AI coding assistants (Claude Code, Codex, Pi, Cursor, …) how to drive the CLI. Install it user-wide so every project picks it up:

onus skill install --global

Target specific agents or copy files instead of symlinking: --agent claude-code codex, --copy.

First commands

Who am I signed in as?

onus me --json

List issues currently in progress:

onus issue list --status in_progress

Emit a machine-readable snapshot of your environment — ideal for agents orienting in a new workspace:

onus context --json

Environment variables

Variable	Purpose	Notes
ONUS_TOKEN	Access token / API key	Alias: ONUS_API_KEY
ONUS_REFRESH_TOKEN	OAuth refresh token	Enables automatic token rotation
ONUS_API_URL	API base URL	Alias: ONUS_BASE_URL; default https://onus.brunyeestudio.com/v1
ONUS_OUTPUT	Force output mode	Set to json for deterministic output

Configuration precedence: CLI flags beat environment variables beat the persistent config file. Browse the endpoints these commands wrap in the API Reference.