Skip to content

Command reference

Use these commands to inspect or change your local Godmode setup. They cover v0.19.2; godmode --help shows installed usage. Never put a secret in a command argument.

You are reading the v0.19.2 documentation. Open the current docs.

More formats
Raw Markdown ↗

Open and inspect#

CommandResult
godmodeOpen the status screen and management actions
godmode --plainUse static text and numbered choices
godmode --no-motionDisable animation
godmode --versionPrint the installed version
godmode helpPrint the agent guide and saved key names
godmode faqRead local help
godmode introReplay the looping two-stage welcome; Enter advances immediately
godmode activeShow the resolved business, key environment and scoped command
godmode active --jsonShow selection names, paths and sources without values
godmode active --commandPrint the exact command prefix for a pinned task
godmode sourcePrint the embedded Python engine
godmode build-infoShow compiler, dependencies, and engine hash

Credentials and providers#

CommandResult
godmode setup [SLUG]Add or replace a provider's keys
godmode provider [SLUG]List providers or print one guide
godmode listPrint saved names only
godmode set NAMESave or replace through a masked prompt
godmode set NAME --stdinRead a value from stdin
godmode run NAME... -- CMDStart a command with selected keys
godmode run VAR=NAME -- CMDSupply a key under another variable name
godmode pathPrint the credential-file path
godmode migrateSeal keys from an older plaintext store
godmode editOpen the file in nano; sealed values stay encrypted

Replace SLUG with a provider slug, NAME with a saved key name, VAR with the variable your tool expects, and CMD with the command to run. Brackets mark optional arguments. See Credentials for examples.

Profile and agent instructions#

CommandResult
godmode profileEdit optional profile fields
godmode profile get FIELDPrint one field
godmode profile showPrint the profile as JSON
godmode profile pathPrint its file path
godmode profile set FIELDSet a field through a visible prompt
godmode profile set FIELD --stdinRead plain text from stdin
godmode profile unset FIELDRemove a field
godmode agentsReview and append the agent note
godmode agents --printPrint the task note for the selected environment and business

Use a field name from Profile. Review Agent instructions before appending the note.

Home and display settings#

Place --home DIR before the command or set GODMODE_HOME to select another home. Use the same home for keys and profiles. GODMODE_CONFIG_DIR is an older alias.

GODMODE_PLAIN=1 selects plain mode, GODMODE_NO_MOTION=1 disables animation, and NO_COLOR=1 disables color.

Businesses and environments#

Separate client keys while reusing each business profile.

godmode context create acme
godmode context map acme STRIPE_SECRET_KEY ACME_STRIPE_SECRET_KEY
godmode --context acme profile
godmode --context acme run STRIPE_SECRET_KEY CLOUDFLARE_API_TOKEN -- your-command

Save ACME_STRIPE_SECRET_KEY with godmode set before mapping it.

CommandResult
godmode use --env NAME --context BUSINESSSave an existing key environment and business as the default
godmode use NAMESave this key environment with the currently resolved business
godmode use --context BUSINESSSave this business with the currently resolved key environment
godmode use --env default --context -Return to default keys and their own profile
godmode env list --jsonList key files and safe metadata
godmode env create NAMECreate an empty key file
godmode env create NAME --copy SOURCECopy a complete file without replacing an existing one
godmode env show NAMEShow names and paths, never values
godmode --env NAME setupEdit keys in one file
godmode --env NAME --context BUSINESS helpSelect keys and reusable business facts
godmode doctor --jsonCheck local files and installation without changing them
godmode updateUpdate the recorded installation
godmode update --version vX.Y.ZInstall a specific published version

Selection resolves separately for keys and business: explicit --env / --context, then GODMODE_ENV / GODMODE_CONTEXT, then the saved active pair, then the original defaults. --context - selects the environment's own profile. use saves a complete pair; an omitted choice uses the current resolved selection, including shell overrides. Saving a default does not unset those overrides. See Businesses and environments for task pinning and recovery.

Godmode v0.19.2 · 2026-11-17 · Inspect the source · Get help