Commands

Every gum CLI command has a generated docs page. Product coverage is documented under Operations by service; this index is for command names, flags, aliases, arguments, and generated help.

Generated pages: 63.

Top-level commands

gum agents - Install gum skills and MCP config for coding agents
gum auth - Manage Google OAuth credentials
gum cache - Inspect or clear the dispatcher response cache
gum call - gum call is the deterministic CLI entry point for catalog operations.
gum canary - gum canary --plugin=<id> [--live] resolves the named plugin under the active install root, spawns it once via the plugin host, and reports the outcome as a stable JSON envelope on stdout. A failed canary surfaces SERVICE_DOWN.
gum catalog - Inspect the resolved catalog
gum code - Run a Risor v2 script in the gum sandbox.
gum completion - Generate the autocompletion script for gum for the specified shell.
gum config - Read or write values in the active profile's config.toml. The active profile is selected via --profile (default: 'default').
gum describe - Return the catalog entry for an op_id (with example_args)
gum destructive - Invoke a destructive op (requires a confirmation token)
gum doctor - Runs a single pre-flight that reports the health of each gum subsystem:
gum gain - Print cumulative gain (token-savings) stats from the local ledger, or replay a fixture set with --fixture-replay.
gum help - Help provides help for any command in the application.
gum init - gum init bootstraps GUM for a new user or project. Default behavior is diff-and-prompt: gum init never silently patches a security-sensitive file. Use --target to pick the host (claude-code | claude-desktop | cursor). Use --refresh to regenerate GUM.md only after a gum upgrade.
gum login - Authorize gum (alias for gum auth login)
gum logout - Clear gum's stored OAuth credentials (switch or sign out of a Google account)
gum mcp - Run the gum MCP server. The public release supports --stdio transport.
gum plugin - Manage gum plugins: install, list, run, and curate third-party subprocess
gum profile - Validate or test an expression profile
gum read - Invoke a read-class catalog op
gum schema - Print a JSON description of the active gum command tree, including command paths, aliases, arguments, and flags.
gum search - BM25 search the embedded catalog (TTY table, pipe JSON)
gum setup - Guided setup for a local gum install. It writes agent skills and MCP config for Codex, Claude, Cursor, or Gemini, then prints the Google OAuth and doctor commands needed for first success.
gum skills - List, print, export, or install version-matched agent skills
gum version - Print the gum version.
gum write - Invoke a write-class catalog op. --allow-write is required for the policy gate to admit the dispatch.

All commands

gum - gum is a single Go binary that exposes the same dispatch kernel via a CLI surface and an MCP stdio server. See the public docs for setup, safety, and command reference.
gum agents - Install gum skills and MCP config for coding agents
gum agents install - Install gum agent files
gum auth - Manage Google OAuth credentials
gum auth login - Authorize gum via your OAuth client (loopback + PKCE; no gcloud)
gum auth probe - Acquire a token for --scopes and print non-secret metadata
gum auth setup - Walk the credential prerequisites for an operation
gum auth status - Print resolved auth provider and scope coverage
gum auth use-ads-developer-token - Store the Google Ads API developer token in the OS keychain so the
gum auth use-api-key - Configure the api_key auth strategy
gum auth use-oauth-client - Register a Desktop-app OAuth client you created in the Google Cloud console.
gum auth use-service-account - Configure the service_account_key auth strategy
gum cache - Inspect or clear the dispatcher response cache
gum cache clear - Clear the dispatcher response cache
gum cache migrate - Migrate BoltDB cache (http.db) to WAL-SQLite (http-wal.db)
gum cache stats - Print dispatcher cache stats
gum call - gum call is the deterministic CLI entry point for catalog operations.
gum canary - gum canary --plugin=<id> [--live] resolves the named plugin under the active install root, spawns it once via the plugin host, and reports the outcome as a stable JSON envelope on stdout. A failed canary surfaces SERVICE_DOWN.
gum catalog - Inspect the resolved catalog
gum catalog list-overrides - List all variants with risk_override=true from the resolved catalog
gum code - Run a Risor v2 script in the gum sandbox.
gum completion - Generate the autocompletion script for gum for the specified shell.
gum completion bash - Generate the autocompletion script for the bash shell.
gum completion fish - Generate the autocompletion script for the fish shell.
gum completion powershell - Generate the autocompletion script for powershell.
gum completion zsh - Generate the autocompletion script for the zsh shell.
gum config - Read or write values in the active profile's config.toml. The active profile is selected via --profile (default: 'default').
gum config get - Print the value of a config key from the active profile
gum config list - List all config keys in the active profile
gum config set - Persist a config key=value pair to the active profile
gum config unset - Remove a config key from the active profile
gum describe - Return the catalog entry for an op_id (with example_args)
gum destructive - Invoke a destructive op (requires a confirmation token)
gum doctor - Runs a single pre-flight that reports the health of each gum subsystem:
gum gain - Print cumulative gain (token-savings) stats from the local ledger, or replay a fixture set with --fixture-replay.
gum help - Help provides help for any command in the application.
gum init - gum init bootstraps GUM for a new user or project. Default behavior is diff-and-prompt: gum init never silently patches a security-sensitive file. Use --target to pick the host (claude-code | claude-desktop | cursor). Use --refresh to regenerate GUM.md only after a gum upgrade.
gum login - Authorize gum (alias for gum auth login)
gum logout - Clear gum's stored OAuth credentials (switch or sign out of a Google account)
gum mcp - Run the gum MCP server. The public release supports --stdio transport.
gum plugin - Manage gum plugins: install, list, run, and curate third-party subprocess
gum plugin install - Installs a plugin through an atomic registry update: validates the manifest,
gum plugin list - List installed plugins
gum plugin reload - Clears any quarantine state for the named plugin, then spawns the subprocess once via the supervisor to act as a passive canary. A spawn failure re-quarantines the plugin.
gum plugin remove - Remove a plugin by ID
gum plugin run - Call a tool on a running plugin
gum plugin setup - Reads the plugin's credential_descriptors from its manifest, prompts for
gum plugin transfer-namespace - Updates the namespace_owner binding for <prefix> in the active profile's
gum plugin unquarantine - Resets quarantined, retry_count, backoff_step, and next_retry_at in plugin-state.json so the plugin can be invoked on the next call. Use when the operator has independently verified the plugin is healthy and wants to bypass the exponential-backoff window.
gum profile - Validate or test an expression profile
gum profile test - When --input is set, applies the profile to that file (optionally comparing against --golden). When --input is omitted, runs every [[tests]] fixture in the profile file through the expression pipeline and prints a ProfileFixtureResult[] JSON envelope (--format=json).
gum profile validate - Parse an expression-profile DSL file and report any errors. Use this in CI to catch malformed catalog profiles before release.
gum read - Invoke a read-class catalog op
gum schema - Print a JSON description of the active gum command tree, including command paths, aliases, arguments, and flags.
gum search - BM25 search the embedded catalog (TTY table, pipe JSON)
gum setup - Guided setup for a local gum install. It writes agent skills and MCP config for Codex, Claude, Cursor, or Gemini, then prints the Google OAuth and doctor commands needed for first success.
gum skills - List, print, export, or install version-matched agent skills
gum skills export - Export installable gum skills
gum skills install - Install gum skills for Codex-compatible agents
gum skills list - List embedded gum agent skills
gum skills show - Print an embedded gum skill
gum version - Print the gum version.
gum write - Invoke a write-class catalog op. --allow-write is required for the policy gate to admit the dispatch.