Skip to content

Connect your agent

Godmode adds a short instruction telling your agent to run godmode help for business details and credentials. This does not grant permission to spend or publish.

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

More formats
Raw Markdown ↗

Review and add the note#

godmode agents

Review the files to create, files to modify, and added lines. The preview shows zero removed lines. Choose Add to… to append the note.

Godmode detects Claude Code, Codex, Gemini CLI, Copilot CLI, and OpenCode by their folders. Existing text stays in place. Files already containing a Godmode marker or godmode help are skipped, including notes you edited.

If a file changes after the preview, review it again. Godmode refuses unsafe file targets and shows a symlink's resolved destination. A disk error can leave an incomplete new note; the original text remains. Check the file before retrying.

If the full preview will not fit, use godmode --plain agents.

Check that it works#

Start a fresh agent session and ask it to run godmode help. It should report saved key names without showing values. Then try a small task using the intended account. If it ignores the note, check the client's active instructions and any project overrides.

Use another agent or one project#

Press c to copy the note, including after every agent is added. For a client task, select its environment and business first. On macOS:

godmode --env acme-test --context acme agents --print | pbcopy

For one project, append it to the instruction file your agent already reads there. Keep the existing text. Check your client's instructions; a filename alone does not make it load.

Pin a task to one setup#

The active setup is a convenience for new commands. Capture it at the start of an agent task so a later default change cannot move that task to another business.

godmode active --command
godmode agents --print

Use the printed command prefix for the task's Godmode calls, or copy the scoped note into its instructions. The note pins both the key environment and business, including the Automatic profile. Installed global notes stay generic.

For a whole agent process, export GODMODE_ENV and GODMODE_CONTEXT before starting it. Explicit command flags take priority over those variables. godmode run pins its selected pair in the child environment. See Businesses and environments for examples.

Fix a missing command or wrong home#

If it cannot find the command, source ~/.godmode/env or use ~/.godmode/bin/godmode. A remote agent needs Godmode installed on that host.

For a custom home, use GODMODE_HOME or --home with every command. The generated note includes that setting. An executable path alone does not select your data directory. See Remote machines.

Remove the note#

Delete only the block from <!-- godmode:start --> through <!-- godmode:end --> in each file you changed. Start a fresh agent session afterward.

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