`qumod` CLI

qumod brings Qumo Deploy to your terminal. What you do in the console, you can do from the command line: create projects, issue and revoke signing keys, invite members, and check usage, billing and the audit log. It also runs a relay on your own machine for a dev project. It is one self-contained binary for macOS, Linux and Windows, with nothing else to install, and it is built to run unattended: in CI, in scripts, and from coding agents. For a short introduction to share with your team, see qumo-deploy.com/cli/qumod.

Quick start

Install

curl -fsSL https://dl.qumo-deploy.com/qumod/install.sh | sh

irm https://dl.qumo-deploy.com/qumod/install.ps1 | iex

The installer checks the download against the release’s SHA256SUMS and needs no sudo. Then open a new terminal so qumod is on your PATH; on macOS and Linux, first add the export PATH=… line the installer prints to your shell profile. Running the installer again updates to the latest release. See Installation for pinned versions and manual downloads.

qumod login

Your browser opens on the console’s device page. Enter the code shown in your terminal and approve it. In CI, skip this step and set QUMO_TOKEN instead (see Authentication).

Run your first command

qumod whoami
qumod project create my-app

Anything you leave out, such as the organization, you pick from a list in the terminal.

What you can do

Task	Command	Console equivalent
Sign in and out, check the identity	`qumod login`, `qumod logout`, `qumod whoami`	Sign-in page
List and create projects	`qumod project list`, `qumod project create`	Projects
Create, list, revoke and export signing keys	`qumod keys create`, `list`, `revoke`, `export`	Signing keys (create and revoke)
Invite and remove members	`qumod members invite`, `list`, `invitations`, `remove`, `uninvite`	Organization settings → Members
See bandwidth over time	`qumod usage`	Usage
See the current bill and invoices	`qumod billing summary`, `qumod billing invoices`	Usage, Organization settings → Plan & billing
Read the audit log	`qumod audit`	Activity, Organization settings → Audit Log
Run a relay on your machine for a dev project	`qumod network create`, `start`, `stop`, `status`, `logs`, `token`	None

Changing the plan or the payment method happens in the console. Each command’s flags are in the Command Reference, and qumod help <command> prints them in the terminal.

Examples

# Create a signing key; the private half is written to this file and never sent
qumod keys create backend --project 7c0e2a4b-5d1f-4a8e-9b3c-2f6d8e1a0b5c --out signing-key.jwk

# Invite a teammate as a project editor
qumod members invite [email protected] --role project.editor

# Hourly bandwidth for one project, as JSON for a script
qumod usage --project 7c0e2a4b-5d1f-4a8e-9b3c-2f6d8e1a0b5c --granularity hour --json

# What changed in the last day
qumod audit --since 24h

On the Free plan, run a relay yourself for your dev project. One command sets it up, signing key included, and another runs it (no Docker needed):

qumod network create my-network
cd my-network && qumod network start

Built for automation

--json writes results to stdout as JSON, one document per line, and errors to stderr.
QUMO_TOKEN (or --token) authenticates with a personal access token, with no browser.
No prompts without a terminal. With --yes, --json, or no TTY, a missing argument is a usage error (exit code 2) instead of a prompt.

See CI/CD & Coding Agents for a GitHub Actions workflow.

Documentation index

Installation

The installers, pinned versions, manual downloads, updating and uninstalling.

Authentication

Browser sign-in with qumod login, or a token for CI and agents.

Command Reference

Every command, flag and example.

CI/CD & Coding Agents

GitHub Actions and GitLab CI recipes, JSON output and exit codes.

CLI Reference

CLI Overview

`qumod` CLI

Quick start

What you can do

Examples

Built for automation

Documentation index

Installation

Authentication

Command Reference

CI/CD & Coding Agents

​qumod CLI

​Quick start

​What you can do

​Examples

​Built for automation

​Documentation index

Installation

Authentication

Command Reference

CI/CD & Coding Agents

`qumod` CLI

Quick start

What you can do

Examples

Built for automation

Documentation index