CLI Setup

Install

The public package name is:

npm install -g @rosterhq/cli

Endpoint

Point the CLI at the Roster MCP endpoint:

https://roster.example.com/mcp

The CLI is MCP-first. It uses MCP tools and does not call the database directly.

OAuth Login

Use browser login for humans:

roster login https://roster.example.com/mcp --name prod
roster auth status
roster resolve "Who should approve the Helios renewal?"

See CLI Authentication for profile storage, aliases, scope presets, logout behavior, and API-key automation.

Human Mode Vs Agent Mode

Human mode is the default. It renders common Roster resources as concise terminal summaries for scanning:

roster --profile prod projects list --query helios
roster --profile prod resolve --explain "Who should approve the Helios renewal?"
roster --profile prod resolve-requests list --limit 5

For Resolve, --explain adds extra lookup details to the human output. It does not change the MCP request.

Agent mode should always use API-key auth, --non-interactive, and --json:

ROSTER_API_KEY=rst_... roster \
  --mcp-url https://roster.example.com/mcp \
  --non-interactive \
  --json \
  participants list --label Finance --limit 10

See CLI Authentication for full OAuth and API-key details, and CLI Commands for the implemented command surface.