Your privacy choices

Allow optional cookies for referral attribution, visit analytics, and Google Ads purchase measurement.

Hermes Deployment Guide

Set up Hermes for terminal AI Agent workflows, including installation, model configuration, and troubleshooting.

Who this is for: Hermes Agent is an open-source terminal AI Agent from Nous Research. It is designed for users who need a local command line, file access, web, image, and voice tools, persistent memory, and messaging gateways. This guide follows the sequence: install the environment → install Hermes → configure an LLM API Gateway model → start chat / gateway → troubleshoot.

SettingRecommended ValueDescription
ProviderMore Provider / Custom / OpenAI CompatibleThe label varies slightly by version. Choose the option that lets you enter a custom URL.
Base URLhttps://api.llm-token.cn/v1Start with the root path that includes /v1. If it does not work, try https://api.llm-token.cn.
API Keysk-xxxxxxxxIt is normal for the terminal not to display the key when you paste it.
Recommended modelclaude-sonnet-4-6Fast responses with Agent support, image understanding, and a large context window. You can also choose another model from the model list.

1. What Is Hermes?

Hermes Agent can chat in the terminal, run commands, read and write files, search files, call web and multimodal tools, and save long-term preferences through persistent memory. You can think of it as an AI Agent that keeps working on your local computer or server.

For beginners: Get command-line chat working before configuring Telegram, Discord, WeChat, or other messaging channels. Establishing this minimal working path first makes later troubleshooting much easier.

2. Choose an Installation Method

SystemRecommended MethodCommand / Notes
Windows / macOS usersHermes DesktopDownload the desktop installer first for the simplest setup.
Linux / macOS / WSL2 / TermuxOfficial one-line script
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
Native Windows PowerShellOfficial PowerShell script
iex (irm https://hermes-agent.nousresearch.com/install.ps1)
Reliable Windows optionWSL2 + UbuntuIf the native Windows installation does not work smoothly, use WSL2.

3. Install with WSL2 on Windows

  1. Open PowerShell as an administrator.
  2. Run the WSL installation command.
wsl --install

If installation gets stuck at 0%, use this command instead:

wsl --install --web-download -d Ubuntu
  1. Restart your computer when prompted.
  2. Set a Linux username and password the first time you open Ubuntu.
  3. Press the Windows key and search for WSL or Ubuntu. If an entry appears, you are ready to continue.

The Windows Subsystem for Linux (WSL) app icon. Search for WSL or Ubuntu from the Windows Start menu to confirm that WSL was installed successfully.The Windows Subsystem for Linux (WSL) app icon. Search for WSL or Ubuntu…

Verify that WSL was installed successfully:

wsl --version

4. Install Git and Hermes

Run the following commands in your WSL2 / Ubuntu terminal:

sudo apt update
sudo apt install git -y
git --version

Then install Hermes:

curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash

After installation, reload your terminal configuration and verify the setup:

source ~/.bashrc
hermes version
hermes doctor

Example output from running hermes --version in a WSL2 / Ubuntu terminal. It shows Hermes Agent v0.8.0 on April 8, 2026, the project path /home/omen/.hermes/hermes-agent, Python 3.11.15, and OpenAI SDK 2.30.0, confirming that Hermes was installed successfully.Example output from running hermes --version in a WSL2 / Ubuntu terminal…

Note: hermes updata in older documentation is a typo. The correct update command is hermes update.


5. Configure an LLM API Gateway Model

  1. Run the following command in the terminal where Hermes is installed:
hermes setup

A terminal after running hermes setup. This starts the Hermes configuration flow used to select quick setup or model settings, choose More Provider or a custom provider, and select an OpenAI-compatible protocol that accepts a custom URL.A terminal after running hermes setup. This starts the Hermes configurat…

  1. Select quick setup or model configuration.
  2. Select More Provider / custom provider.
  3. Select OpenAI Compatible or another protocol that accepts a custom URL.

A dark Hermes terminal setup screen showing messaging platform options such as Telegram and Discord, including a recommended option to set up messaging now. This screen appears during the Hermes configuration flow.A dark Hermes terminal setup screen showing messaging platform options s…

The provider selection screen in the Hermes terminal. Options such as Nous Portal and OpenRouter are listed, and a green arrow points to More providers, which opens the custom provider choices.The provider selection screen in the Hermes terminal. Options such as No…

The Hermes provider selection screen with options such as GitHub Copilot ACP and Google AI Studio. A green arrow highlights Custom endpoint, where you can enter a URL manually.The Hermes provider selection screen with options such as GitHub Copilot…

When entering the URL, try this first:

https://api.llm-token.cn/v1

If validation fails in your current version, try:

https://api.llm-token.cn

The custom OpenAI-compatible endpoint configuration screen in Hermes. The page shows https://api.example.com/v1 as the example format, and the API base URL field contains https://api.llm-token.cn/v1.The custom OpenAI-compatible endpoint configuration screen in Hermes. Th…

  1. Paste the API Key. It is normal for the terminal not to display it. Press Enter after pasting.
  2. Start by selecting claude-sonnet-4-6 for testing.
  3. If Hermes asks for a context length, you can enter a large context window for claude-sonnet-4-6. If the client enforces strict limits, start with 32000, confirm that it works, and increase it gradually.
  4. You can skip messaging channels the first time and configure the gateway after terminal chat is working.

The Hermes terminal after the https://api.example.com/v1 endpoint has been validated. It lists 33 available models, including claude-sonnet-4-6 and claude-sonnet-4-6-thinking, and prompts the user to select one by number. Option 1 is claude-sonnet-4-6, and option 33 is glm-4.6v.The Hermes terminal after the https://api.example.com/v1 endpoint has be…

The messaging platform prompt shown before Hermes chat starts. The options are Set up messaging now and Skip to set it up later with hermes setup gateway. The Skip option is selected.The messaging platform prompt shown before Hermes chat starts. The optio…

6. Start Chat and the Gateway

After configuration is complete, you can open chat directly. If the interface asks whether to start chat, enter Y.

The Hermes setup completion screen showing Ready to go and commands for starting chat, launching the messaging gateway, and checking for issues. A Y/n prompt asks whether to launch Hermes chat immediately.The Hermes setup completion screen showing Ready to go and commands for…

If you configured a messaging channel but it does not respond, start or check the gateway:

hermes gateway
hermes gateway status

7. Common Commands

CommandPurpose
hermesStart chatting.
hermes setupOpen the full setup wizard again.
hermes modelSwitch models or providers.
hermes doctorDiagnose dependencies, configuration, and service status.
hermes updateUpdate Hermes.
hermes --continueResume the previous session.

8. Troubleshooting

IssueSolution
hermes: command not foundRun source ~/.bashrc or reopen the terminal. If the command is still unavailable, check your PATH.
Model validation failsCheck the URL, API Key, and model ID. Try https://api.llm-token.cn/v1 first.
Responses are cut off or the context is too smallReturn to hermes setup or adjust the context length in the configuration file. Confirm the basic setup works before increasing the context window.
WSL2 cannot access a local Windows serviceOn Windows 11, try WSL mirrored networking. On Windows 10, use the default WSL gateway IP instead of localhost.
Configuration is missing after an updateRun hermes config check and hermes config migrate.
[wsl2]
networkingMode=mirrored
wsl --shutdown