Command Reference

The qumod CLI follows standard POSIX conventions:

qumod <command> [subcommand] [flags]

Global Flags

These flags can be provided to any qumod command:

Flag	Short	Description
`--token <string>`		Bearer token / API key. Overrides environment variable and stored session.
`--api-url <string>`		Control plane API endpoint (default: `https://api.qumo.dev` or `QUMO_API_URL`).
`--json`		Formats CLI output into structured JSON with consistent schemas.
`--help`	`-h`	Prints usage and available options for the command.
`--version`	`-v`	Prints the version and platform architecture.

Initiates the OAuth 2.0 Device Flow to authorize a workstation in the browser.

Usage

qumod login [flags]

Options

--api-url <url>: Specify a private control plane or local development cluster.
--json: Outputs pending authorization metadata { "status": "pending", "verification_uri": "...", "user_code": "..." }.

`qumod logout`

Invalidates stored session tokens in ~/.qumo/config.json.

Usage

qumod logout

`qumod whoami`

Displays the active user identity, organization / tenant ID, IAM role, and associated workspace memberships.

Usage

qumod whoami [flags]

Examples

qumod whoami

qumod whoami --json

`qumod project`

Manage isolated deployment projects within your active tenant workspace.

Subcommands

`qumod project list` (alias: `qumod project ls`)

Lists all projects available to the tenant.

qumod project list

Sample table output:

┌─────────────────┬──────────────────────┬──────────────────────┬─────────────┐
│ (index)         │ ID                   │ Name                 │ Environment │
├─────────────────┼──────────────────────┼──────────────────────┼─────────────┤
│ 0               │ "prj_prod_01"        │ "live-stream-prod"   │ "production"│
│ 1               │ "prj_stage_02"       │ "live-stream-test"   │ "test"      │
└─────────────────┴──────────────────────┴──────────────────────┴─────────────┘

`qumod project create <name> [--env <environment>]`

Provisions a new deployment project.

qumod project create my-auction-stream --env production

Flags:

--env <production|test>: Deployment environment tier (default: production).

`qumod deploy`

Triggers or inspects deployments for edge relays and workload services.

Usage

qumod deploy [--project <project-id-or-name>] [flags]

Options

--project <id|name>: Target project ID or project name. If omitted, qumod deploys to the first available project in the workspace.
--json: Emits deployment status in JSON for CI/CD assertions.

Example

qumod deploy --project prj_prod_01 --json

{
  "success": true,
  "project_id": "prj_prod_01",
  "project_name": "live-stream-prod",
  "environment": "production",
  "status": "ready"
}

`qumod version`

Displays the installed CLI version, architecture, and current target API URL.

qumod version

​Command Reference

​Global Flags

​qumod login

​Usage

​Options

​qumod logout

​Usage

​qumod whoami

​Usage

​Examples

​qumod project

​Subcommands

​qumod project list (alias: qumod project ls)

​qumod project create <name> [--env <environment>]

​qumod deploy

​Usage

​Options

​Example

​qumod version

Command Reference

Global Flags

`qumod login`

Usage

Options

`qumod logout`

Usage

`qumod whoami`

Usage

Examples

`qumod project`

Subcommands

`qumod project list` (alias: `qumod project ls`)

`qumod project create <name> [--env <environment>]`

`qumod deploy`

Usage

Options

Example

`qumod version`