Skip to main content
1

Configure a model provider

Run the setup wizard to choose your inference provider:
The wizard presents a list of supported providers. Use the arrow keys to select one and press Enter:You can switch providers at any time with hermes model or /model inside a conversation.
2

Set your API key

After selecting a provider, the wizard prompts you to enter your API key. Keys are saved to ~/.hermes/.env with owner-only permissions (0600).For providers that use OAuth (Nous Portal, OpenAI Codex), the wizard opens your browser to complete login — no API key is required.To set or update a key later without re-running the full wizard:
Or edit ~/.hermes/.env directly.
3

Start Hermes

Launch the interactive terminal UI:
You’ll see the Hermes banner showing your active provider and model. Type a message and press Enter:
Hermes responds in a streaming panel. When the agent uses tools, you see live tool output in the activity feed:
The prefix marks tool output. Each tool call — file reads, shell commands, web searches — streams as it runs so you always know what the agent is doing.
4

Use slash commands

Type / at the prompt to see autocomplete suggestions. Key commands:
Run /help at any time to see the full list of commands, organized by category. Commands that are only available in the CLI or only in messaging platforms are labeled accordingly.
To interrupt the agent mid-task, press Ctrl+C. You can send a follow-up message to redirect it without losing context.

What Hermes remembers

Hermes maintains persistent memory across sessions:
  • MEMORY.md — a curated, bounded list of facts the agent has learned about your preferences, projects, and working style.
  • USER.md — a user profile the agent builds over time (goals, communication style, frequently used tools).
Both files live in ~/.hermes/ and are injected into the system prompt on every session. The agent updates them autonomously — you can also edit them directly.

Next steps

CLI Reference

All hermes subcommands and flags.

Configuration

Customize the model, toolsets, terminal backend, and display.

Tools & Toolsets

40+ built-in tools and how to enable or disable them.

Messaging Gateway

Connect Hermes to Telegram, Discord, Slack, WhatsApp, and more.