apikumo
Launch App
CLI

Install apikumo CLI

Standalone binary, Homebrew, or npm · macOS, Linux, and Windows

Push specs in one commandDry-run diff previewNo runtime dependencies

Why apikumo CLI?

Push from the terminal

Sync your OpenAPI spec with one command. Docs updated instantly.

Dry-run before you commit

Use --dry-run to validate your spec and preview exactly what will change — before anything is persisted.

Token-based auth

Login once via device-code flow. Token stored in your system keychain. Revoke anytime from the dashboard.

brew install apikumo/tap/apikumo
brew upgrade apikumo

To upgrade

Requires Homebrew

Quick start

apikumo — zsh
$

CLI reference

CommandDescription
apikumo login

Authenticate via device-code flow — shows a verification code, opens your browser to approve.

  • --no-promptSkip the "Press Enter to open browser" confirmation — useful in scripts.
apikumo logout

Clear the stored token and cached user info from this machine.

apikumo whoami

Print the authenticated user — email, user_id, and token_id. Result is cached for 1 hour.

  • --refreshBypass the cache and re-fetch from the server.
apikumo init

Interactive wizard: select org → workspace → collection, then set the source folder that holds your OpenAPI files. Writes .apikumo/config.json.

apikumo push

Push OpenAPI spec(s) to apikumo. Without --file, discovers specs in the configured source folder and shows an interactive picker.

  • --file <path>Push a single file instead of scanning the source folder.
  • --summary <text>Attach a short note describing what changed in this push.
  • --dry-runValidate the spec and show a diff of what would change — nothing is persisted.
apikumo status

Print current auth state, bound collection ID, and source folder (with file count).

apikumo token show

Print the stored token so it can be pasted into a CI secret (e.g. APIKUMO_TOKEN).

  • --yesPrint it even in a non-interactive shell or when CI is set.
apikumo test list

List the test suite slugs available in the resolved workspace.

  • --workspace <id>List suites from a specific workspace.
apikumo test run <suite-slug>

Run a test suite by slug — validates every step before spending quota, then executes and prints a pass/fail summary. Exits 0 (pass), 1 (failure), or 2 (could not run). Authenticate CI with the APIKUMO_TOKEN env var.

  • --env <name>Run against a specific environment.
  • --workspace <id>Run a suite from a specific workspace.
  • --timeout <seconds>Override the default per-step timeout.
apikumo telemetry

Manage anonymous telemetry opt-in — sends only command counts, version, and platform, no personal data. Pass enable, disable, or status (default).