CLI

Install APIKumo CLI

Standalone binary — no Node.js required · macOS and Linux

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 telemetry

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