Skip to content

Command reference

These commands cover Godmode v0.20.0. Run godmode --help for the installed command list or godmode help COMMAND for most commands. In the examples below, replace uppercase placeholders with your own names or command.

View Markdown

Open and inspect#

CommandResult
godmodeOpen the terminal interface.
godmode --versionPrint the installed version.
godmode helpPrint the agent guide for the selected setup, including saved key names.
godmode faqRead local setup and troubleshooting help.
godmode introReplay the welcome.
godmode doctor, godmode doctor --jsonCheck the local install, selected files and detected agent notes. Failed checks return exit status 1.
godmode sourcePrint the embedded Python file engine.
godmode build-infoPrint compiler, dependencies and engine hash.

Credentials and providers#

CommandResult
godmode setup, godmode setup PROVIDERChoose a provider or open its setup screen directly.
godmode provider, godmode provider PROVIDERList providers or show setup, verification and recovery steps for one.
godmode listPrint saved key names, one per line. An invalid store can return a nonzero status.
godmode set NAME, godmode set NAME --stdinSave a value through a masked prompt or read it from stdin.
godmode run NAME... -- CMDAdd only the requested saved keys to the command's inherited environment.
godmode run VAR=NAME -- CMDSupply a saved key under the variable the command expects.
godmode pathPrint the selected credential file's path.
godmode editOpen the file in nano. Sealed entries stay encrypted.
godmode migrateSeal keys from an older plaintext store.

Keep credentials out of command arguments and chat. For an account check, run a provider's read-only command with the minimum key set. See Providers.

Profile and agent instructions#

CommandResult
godmode profileEdit the optional business fields.
godmode profile show, godmode profile pathPrint the selected profile as JSON or print its file path.
godmode profile get FIELDPrint one field. An unset field returns exit status 1.
godmode profile set FIELD, godmode profile set FIELD --stdinSet a field through a visible prompt or from stdin.
godmode profile unset FIELDRemove a field.
godmode agentsCopy the selected task note or review additions to detected agent files.
godmode agents --printPrint the note scoped to the selected setup.

See Business profile for field names and Connect your agent for the review and verification steps.

Home and display settings#

In the terminal UI, use the arrow keys to move, Enter to open, and Esc to go back. Press Ctrl-K to find an action or ? for keyboard help.

Option or commandResult
--home DIRSelect a Godmode home. The default is ~/.godmode.
--plainUse static text and numbered menus for this invocation.
--no-motionDisable animations for this invocation.
godmode settingsOpen Settings in a terminal or report the motion preference in plain mode.
godmode settings --jsonRead the stored motion preference and its path.
godmode settings motion on, godmode settings motion offSave the motion preference.

GODMODE_HOME also selects a home. The older GODMODE_CONFIG_DIR alias still works. Use GODMODE_PLAIN=1, GODMODE_NO_MOTION=1 or NO_COLOR=1 for shell-wide display overrides.

Businesses and environments#

CommandResult
godmode active, godmode active --jsonInspect the resolved key environment and business profile. JSON includes paths and selection sources.
godmode active --commandPrint the full command prefix that pins the current setup.
godmode use --env NAME --context BUSINESSSave the active pair for future commands. Omit one flag to keep that part of the current selection. godmode use NAME is shorthand for godmode use --env NAME.
godmode env, godmode env listList key environment names. Add --json to env list for metadata.
godmode env create NAME, godmode env create NAME --copy SOURCECreate an empty store or an independent copy.
godmode env show NAMEShow the environment's paths and saved names.
godmode context, godmode context listList business profile names.
godmode context show BUSINESSShow a profile path and its key mappings.
godmode context create BUSINESSCreate a named business profile.
godmode context map BUSINESS VARIABLE SAVED_KEYResolve a variable through another key name in the selected store.
godmode context unmap BUSINESS VARIABLERemove a key mapping.

For one command, put --env NAME and --context BUSINESS before the command. --env default selects the default store. --context - selects Automatic, which uses that environment's own profile. Explicit flags take priority over shell variables, which take priority over the saved setup. See Businesses and environments.

Update the installation#

CommandResult
godmodeup, godmode updateUpdate the recorded installation to the latest available release.
godmodeup --version vX.Y.Z, godmode update --version vX.Y.ZInstall a specific published version.

See Installation for recovery and Licensing for earlier paid releases. Run godmode license --help for receipt commands.

Godmode v0.20.0 · 2026-11-19 · Inspect the source · Get help