hermes setup Command — Complete Reference & Examples

Overview

hermes setup is the interactive configuration wizard for Hermes Agent. Running it without arguments launches the full wizard, which re-runs configuration showing your current values as defaults. You can also target a single section by passing its name as an argument.

Usage

hermes setup [-h] [--non-interactive] [--reset] [--reconfigure] [--quick] [--portal]
             [{model,tts,terminal,gateway,tools,telemetry,agent}]

Setup Sections

Run a specific section instead of the full wizard:

Section	What it configures
`model`	Default model, provider, and API credentials
`tts`	Text-to-speech provider and voice settings
`terminal`	Terminal backend (local, docker, ssh, modal) and defaults
`gateway`	Messaging platforms (Telegram, Discord, Slack, etc.)
`tools`	Which toolsets are enabled by default
`telemetry`	Usage analytics and telemetry preferences
`agent`	Agent behavior, max turns, and session defaults

hermes setup model
hermes setup gateway
hermes setup tools

Options

Option	Description
`--non-interactive`	Non-interactive mode (use defaults/env vars)
`--reset`	Reset configuration to defaults
`--reconfigure`	(Default on existing installs.) Re-run the full wizard, showing current values as defaults. Kept for backwards compatibility — a bare `hermes setup` now does this.
`--quick`	On existing installs: only prompt for items that are missing or unset, instead of running the full reconfigure wizard
`--portal`	One-shot Nous Portal setup: log in via OAuth, pick a Nous model, set Nous as the inference provider, and opt into the Tool Gateway. Skips the rest of the wizard.

Examples

# Run the full wizard (reconfigures, showing current values as defaults)
hermes setup

# Configure only the model section
hermes setup model

# Set up the messaging gateway
hermes setup gateway

# Reset everything to defaults
hermes setup --reset

# Only prompt for missing/unset items on an existing install
hermes setup --quick

# One-shot Nous Portal OAuth setup
hermes setup --portal

# Non-interactive setup for scripts/CI
hermes setup --non-interactive

Tips

On existing installs, a bare hermes setup re-runs the wizard with your current values as defaults — it is safe to re-run anytime.
Use --quick to only be asked about items that are missing or unset.
Use --non-interactive for headless or scripted setups, relying on defaults and environment variables.
After setup, run hermes doctor to verify the configuration is complete and working.
For a single change, hermes config set key value is faster than the full wizard.