Skip to content

gormes setup

Guided interactive setup — provider, model, and more.

setup is section-driven, not a subcommand tree. Pass a section as a positional argument, or run gormes setup to walk the full wizard.

SectionPurpose
providerConfigure provider credentials and routing
modelSelect the active provider/model
agentShow multi-agent setup guidance
workspaceShow default workspace guidance
profilesManage profiles and persist per-profile workspace/channel lists
bindingsShow channel-to-agent binding guidance
ttsConfigure text-to-speech
terminalConfigure the terminal backend
gatewayConfigure messaging gateways
toolsConfigure tool groups

gormes setup gateway writes channel credentials and allowlists as profile-owned bindings (profiles.<id>.channels.<channel> plus credentials.<id>) so Telegram, Discord, Slack, WhatsApp, and Navivox setup follows the active profile instead of becoming shared global state.

gormes setup profiles writes agents.defaults.workspaces into the selected profile’s own config.toml. An empty list means the operator home is the default project workspace, while a non-empty list restricts model-facing project read/write work to those roots. Runtime internals still use the active profile root for state, but model-facing profile edits are limited to explicit profile-owned content such as SOUL.md, IDENTITY.md, and skills/; secrets and runtime databases are not project workspaces. File tools, project-mode execute_code, and coding-agent delegation share this resolver. The local terminal fails closed under a non-empty list until a sandbox-capable backend is available.

gormes setup [section] [flags]
FlagDefaultPurpose
-h, --helphelp for setup
--jsonfalseemit machine-readable JSON for --reset: {build, action: 'reset', config_path, breadcrumb_path}
--non-interactivefalseuse defaults/env and never prompt
--quickfalseconfigure missing setup items only
--reconfigurefalsere-run the setup wizard against the current config (non-destructive; existing values are kept where the operator skips a step)
--resetfalseDESTRUCTIVE: overwrite config.toml back to defaults, then re-run the setup wizard