Skip to main content

CLI Authentication

qumod supports two authentication workflows:
  1. Interactive Browser Login (Device Authorization Flow): Ideal for developers working locally on workstations.
  2. Headless Token Authentication (QUMO_TOKEN): Ideal for CI/CD runners, Docker containers, and Coding Agents.

1. Interactive Device Authorization Flow

Run the login command:
qumod will initiate the OAuth 2.0 Device Authorization Flow (RFC 8628):
  1. The CLI will attempt to launch your system browser automatically.
  2. If running over SSH or a headless display, open the displayed URL manually and enter the one-time user code.
  3. Sign in using your Qumo Deploy account and click Approve.
  4. The CLI polls the control plane and automatically saves the issued session token to ~/.qumo/config.json.

2. Headless Authentication (CI/CD & Coding Agents)

In automated environments where interactive prompts are impossible, pass credentials via an environment variable or flag: Export QUMO_TOKEN with an API Key or Personal Access Token (PAT):

Command Flag

You can also pass the token per-invocation using --token:
Flags take precedence over environment variables, which take precedence over saved tokens in ~/.qumo/config.json.

Checking Current Identity (whoami)

To confirm authentication status, organization details, and IAM roles:
Sample output:

JSON Mode for Scripts and Agents

Pass --json for structured, machine-readable output:

Logging Out

To clear local credentials and invalidate the active session: