Skip to main content

Quickstart

This guide walks you through installing Hermes Agent, setting up a provider, and having your first conversation. By the end, you'll know the key features and how to explore further.

1. Install Hermes Agent​

Run the one-line installer:

# Linux / macOS / WSL2
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
Windows Users

Install WSL2 first, then run the command above inside your WSL2 terminal.

After it finishes, reload your shell:

source ~/.bashrc   # or source ~/.zshrc

2. Set Up a Provider​

The installer runs the setup wizard automatically. If you skipped it, run:

hermes setup

This walks you through selecting an inference provider:

ProviderWhat it isHow to set up
Nous PortalSubscription-based, zero-configOAuth login via hermes model
OpenAI CodexChatGPT OAuth, uses Codex modelsDevice code auth via hermes model
OpenRouter200+ models, pay-per-useEnter your API key
Custom EndpointVLLM, SGLang, any OpenAI-compatible APISet base URL + API key
tip

You can switch providers at any time with hermes model — no code changes, no lock-in.

3. Start Chatting​

hermes

That's it! You'll see a welcome banner with your model, available tools, and skills. Type a message and press Enter.

❯ What can you help me with?

The agent has access to tools for web search, file operations, terminal commands, and more — all out of the box.

4. Try Key Features​

Ask it to use the terminal​

❯ What's my disk usage? Show the top 5 largest directories.

The agent will run terminal commands on your behalf and show you the results.

Use slash commands​

Type / to see an autocomplete dropdown of all commands:

CommandWhat it does
/helpShow all available commands
/toolsList available tools
/modelSwitch models interactively
/personality pirateTry a fun personality
/saveSave the conversation

Multi-line input​

Press Alt+Enter or Ctrl+J to add a new line. Great for pasting code or writing detailed prompts.

Interrupt the agent​

If the agent is taking too long, just type a new message and press Enter — it interrupts the current task and switches to your new instructions. Ctrl+C also works.

Resume a session​

When you exit, hermes prints a resume command:

hermes --continue    # Resume the most recent session
hermes -c            # Short form

5. Explore Further​

Here are some things to try next:

Set up a sandboxed terminal​

For safety, run the agent in a Docker container or on a remote server:

hermes config set terminal.backend docker    # Docker isolation
hermes config set terminal.backend ssh       # Remote server

Connect messaging platforms​

Chat with Hermes from your phone via Telegram, Discord, Slack, or WhatsApp:

hermes gateway setup    # Interactive platform configuration

Schedule automated tasks​

❯ Every morning at 9am, check Hacker News for AI news and send me a summary on Telegram.

The agent will set up a cron job that runs automatically via the gateway.

Browse and install skills​

hermes skills search kubernetes
hermes skills install openai/skills/k8s

Or use the /skills slash command inside chat.

Try MCP servers​

Connect to external tools via the Model Context Protocol:

# Add to ~/.hermes/config.yaml
mcp_servers:
  github:
    command: npx
    args: ["-y", "@modelcontextprotocol/server-github"]
    env:
      GITHUB_PERSONAL_ACCESS_TOKEN: "ghp_xxx"

Quick Reference​

CommandDescription
hermesStart chatting
hermes setupConfigure providers and settings
hermes modelSwitch provider or model
hermes toolsConfigure which tools are enabled per platform
hermes doctorDiagnose issues
hermes updateUpdate to latest version
hermes gatewayStart the messaging gateway
hermes --continueResume last session

Next Steps​