Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/techjarves/Hermes-USB-Portable/llms.txt

Use this file to discover all available pages before exploring further.

hermes setup runs the interactive wizard that configures LLM providers, terminal backends, messaging gateways, tools, and agent behavior. hermes config provides direct access to config.yaml values without going through the wizard. On first run, Hermes Portable will prompt you to run setup automatically. You can re-run it any time to change providers or reconfigure any aspect of the agent.

​
Setup Commands

CommandDescription
hermes setupFull interactive setup wizard
hermes setup modelChange model/provider only
hermes setup terminalChange terminal backend
hermes setup gatewayConfigure messaging platforms
hermes setup toolsConfigure tool providers
hermes setup agentCustomize agent behavior

​
Config Commands

CommandDescription
hermes configView current configuration
hermes config editOpen config.yaml in the default editor
hermes config set <key> <value>Set a specific config value
hermes config get <key>Get a specific config value

​
Config File Location

Hermes Portable stores all configuration in: 
data/config.yaml
This maps to HERMES_HOME/config.yaml inside the portable environment. Your API keys are stored separately in data/.env.
Do not edit data/config.yaml or data/.env manually while Hermes is running — changes may be overwritten. Use hermes config edit or stop the agent first.

​
Examples

# Run the full setup wizard
./launch.sh setup

# Change only the model/provider
./launch.sh hermes setup model

# View current config
./launch.sh hermes config

# Open config.yaml for manual editing
./launch.sh hermes config edit

# Set a specific config key
./launch.sh hermes config set model.default gpt-4o

# Read a specific config key
./launch.sh hermes config get model.default

​
Setting Up API Keys

API keys are stored in data/.env. You can add them manually: 
# Add the keys for the providers you wish to use:
OPENROUTER_API_KEY=sk-or-v1-xxxxxxxxxxxxxxxx
OPENAI_API_KEY=sk-proj-xxxxxxxxxxxxxxxx
ANTHROPIC_API_KEY=sk-ant-xxxxxxxxxxxxxxxx
Or run the setup wizard to configure them interactively: 
./launch.sh setup

​
Using a Local Ollama Instance

To connect Hermes Portable to a locally running Ollama server:
  1. Start Ollama and pull a model: ollama pull qwen3.6
  2. Run ./launch.sh setup and choose Quick setup
  3. Select More providers → Custom endpoint (enter URL manually)
  4. Enter the Ollama endpoint: http://127.0.0.1:11434/v1
  5. Leave the API key blank and select the detected model
For a remote Ollama host, use the same /v1 endpoint format — for example http://192.168.1.20:11434/v1. Make sure the Ollama host is reachable from the computer running Hermes Portable.

Build docs developers (and LLMs) love

Get started for freeTalk to us