No description
Find a file
Teknium d94fb47717 hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points
Codebase-wide fix for Python-on-Windows UTF-8 footguns, complementing
the earlier execute_code sandbox fixes (which remain load-bearing for
when the sandbox explicitly scrubs child env).

Problem: Python on Windows has two long-standing text-encoding pitfalls:

  1. sys.stdout/stderr are bound to the console code page (cp1252 on
     US-locale installs) — print('café') crashes with UnicodeEncodeError.
  2. Subprocess children don't know to use UTF-8 unless PYTHONUTF8 and/or
     PYTHONIOENCODING are set in their env — so any Python we spawn
     (linters, sandbox children, delegation workers) hits the same bug.

Solution: A tiny bootstrap module (hermes_bootstrap.py) imported as the
first statement of every Hermes entry point:

  - hermes_cli/main.py   (hermes / hermes-agent console_script)
  - run_agent.py         (hermes-agent direct)
  - acp_adapter/entry.py (hermes-acp)
  - gateway/run.py       (messaging gateway)
  - batch_runner.py      (parallel batch mode)
  - cli.py               (legacy direct-launch CLI)

On Windows, the bootstrap:
  - os.environ.setdefault('PYTHONUTF8', '1')       (PEP 540 UTF-8 mode)
  - os.environ.setdefault('PYTHONIOENCODING', 'utf-8')
  - sys.stdout/stderr/stdin.reconfigure(encoding='utf-8', errors='replace')

Children inherit the env vars → they run in UTF-8 mode.
Current process's stdio is reconfigured → print('café') works now.

On POSIX (Linux/macOS), the bootstrap is a complete no-op.  We don't
touch LANG, LC_*, or anything else — users who have intentionally
configured a non-UTF-8 locale aren't affected.  POSIX systems are
already UTF-8 by default in 99% of modern setups, so there's nothing
to fix.

setdefault() (not overwrite) means users who explicitly set PYTHONUTF8=0
or PYTHONIOENCODING=cp1252 in their environment are respected.

What this does NOT fix: bare open(path, 'w') calls in the *parent*
process still default to locale encoding because PYTHONUTF8 is only
read at interpreter init.  A ruff PLW1514 sweep (separate follow-up)
will add explicit encoding='utf-8' at those ~219 call sites for
belt-and-suspenders.

Tests (17): 16 passed, 1 skipped on Windows.
  - Windows: env vars set, stdio reconfigured, child inherits UTF-8 mode
  - POSIX: complete no-op (verified on fake POSIX + skipped on real
    POSIX since we don't have a Linux box in this session)
  - Idempotence: multiple calls safe
  - Graceful degradation: non-reconfigurable streams don't crash
  - User opt-out: explicit PYTHONUTF8=0 is respected
  - Load order: every entry point's FIRST top-level import is
    hermes_bootstrap, enforced by an AST-level parametrized test

pyproject.toml: added hermes_bootstrap to py-modules so it ships with
pip installs.
2026-05-08 14:27:40 -07:00
.github fix: add dashboard to CLI help epilogue and Docker CI smoke test 2026-05-07 06:16:23 -07:00
.plans Merge PR #724: feat: --yolo flag to bypass all approval prompts 2026-03-10 20:56:30 -07:00
acp_adapter hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
acp_registry feat: restore ACP server implementation from PR #949 (#1254) 2026-03-14 00:09:05 -07:00
agent feat(computer-use): background focus-safe backend — set_value, structured windows, MIME detection 2026-05-08 11:07:38 -07:00
assets Update banner image to new version 2026-02-25 11:53:44 -08:00
cron feat(windows): close remaining POSIX-only landmines — TUI crash, kanban waitpid, AF_UNIX sandbox, /bin/bash, npm .cmd shims, cwd tracking, detach flags 2026-05-08 14:27:40 -07:00
datagen-config-examples feat: add WebResearchEnv RL environment for multi-step web research 2026-03-05 14:34:36 +00:00
docker feat(docker): bootstrap auth.json from env on first boot 2026-05-08 06:28:44 -07:00
docs feat: add Telegram DM topic-mode sessions 2026-05-04 12:07:17 -07:00
environments docs: align terminal-backend count and naming across docs and code 2026-05-05 13:44:09 -07:00
gateway hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
hermes_cli hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
locales fix: add Turkish locale references in config, tests, and docs 2026-05-05 17:29:12 -07:00
nix fix(nix): refresh stale tui npmDepsHash + fix cache-blind detection (#20144) 2026-05-05 15:32:20 +05:30
optional-skills feat(skills): watchers skill — poll RSS / HTTP JSON / GitHub via cron no-agent (#21881) 2026-05-08 09:27:15 -07:00
packaging/homebrew chore: prepare Hermes for Homebrew packaging (#4099) 2026-03-30 17:34:43 -07:00
plans fix(gemini): tighten native routing and streaming replay 2026-04-19 12:40:08 -07:00
plugins refactor(teams): remove redundant delivery-mode branch 2026-05-08 12:00:09 -07:00
providers feat(providers): make all 33 providers pluggable under plugins/model-providers/ 2026-05-05 13:40:01 -07:00
scripts fix(windows): prefer npm.cmd over npm.ps1, skip .py argv0 in relaunch 2026-05-08 14:27:40 -07:00
skills docs(teams-pipeline): cron renewal recipe, sidebar wiring, skill rewrite 2026-05-08 12:41:41 -07:00
tests hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
tinker-atropos@65f084ee80 Add tinker-atropos submodule and update RL training tools 2026-02-04 10:36:01 -08:00
tools execute_code: set PYTHONIOENCODING=utf-8 + PYTHONUTF8=1 in child env 2026-05-08 14:27:40 -07:00
tui_gateway feat(windows): close remaining POSIX-only landmines — TUI crash, kanban waitpid, AF_UNIX sandbox, /bin/bash, npm .cmd shims, cwd tracking, detach flags 2026-05-08 14:27:40 -07:00
ui-tui feat(tui): support attaching to an existing gateway (#21978) 2026-05-08 12:12:38 -07:00
web fix(dashboard): finish resumeId -> resumeParam rename in ChatPage (#21317) 2026-05-07 07:05:03 -07:00
website feat(windows-install): bundle portable MinGit instead of relying on winget 2026-05-08 14:27:40 -07:00
.dockerignore fix(docker): exclude compose/profile runtime state from build context 2026-05-04 02:31:39 -07:00
.env.example feat(plugins/google_chat): Google Chat platform adapter as a bundled plugin 2026-05-07 07:15:44 -07:00
.envrc nix: add tui lockfile update script 2026-04-10 00:46:37 -04:00
.gitattributes feat: web UI dashboard for managing Hermes Agent (#8756) 2026-04-12 22:26:28 -07:00
.gitignore feat(providers): add GMI Cloud as a first-class API-key provider (#11955) 2026-04-27 11:17:59 -07:00
.gitmodules refactor: remove mini-swe-agent dependency — inline Docker/Modal backends (#2804) 2026-03-24 07:30:25 -07:00
.mailmap chore: add MestreY0d4-Uninter to AUTHOR_MAP and .mailmap 2026-04-15 15:03:28 -07:00
AGENTS.md docs: pluggable surfaces coverage — model-provider guide, full plugin map, opt-in fix (#20749) 2026-05-06 07:24:42 -07:00
batch_runner.py hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
cli-config.yaml.example feat(plugins/google_chat): Google Chat platform adapter as a bundled plugin 2026-05-07 07:15:44 -07:00
cli.py hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
constraints-termux.txt feat: add tested Termux install path and EOF-aware gh auth 2026-04-09 16:24:53 -07:00
CONTRIBUTING.md docs(contributing): align tool discovery and test runner with AGENTS.md 2026-05-07 05:40:19 -07:00
docker-compose.yml feat(plugins/google_chat): Google Chat platform adapter as a bundled plugin 2026-05-07 07:15:44 -07:00
Dockerfile fix(docker): chown runtime node_modules trees to hermes user (#18800) 2026-05-07 06:17:49 -07:00
flake.lock fix nix build 2026-04-11 15:30:37 -04:00
flake.nix feat(nix): declarative plugin installation for NixOS module (#15953) 2026-04-28 00:18:32 +05:30
hermes fix: use argparse entrypoint in top-level launcher (#3874) 2026-03-29 21:54:36 -07:00
hermes-already-has-routines.md docs: automation templates gallery + comparison post (#9821) 2026-04-14 12:30:50 -07:00
hermes_bootstrap.py hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
hermes_constants.py fix(constants): warn once when get_hermes_home() falls back under an active profile (#18746) 2026-05-02 01:49:55 -07:00
hermes_logging.py fix(logging): attach gateway log after cli init 2026-04-26 19:01:26 -07:00
hermes_state.py fix(analytics): prevent silent token loss and add Claude 4.5–4.7 pricing (#21455) 2026-05-07 13:24:31 -07:00
hermes_time.py refactor: extract shared helpers to deduplicate repeated code patterns (#7917) 2026-04-11 13:59:52 -07:00
LICENSE fix: restore missing MIT license file 2026-03-07 13:43:08 -08:00
MANIFEST.in chore: prepare Hermes for Homebrew packaging (#4099) 2026-03-30 17:34:43 -07:00
mcp_serve.py fix(mcp): unwrap platforms key in channels_list 2026-05-07 13:41:16 -07:00
mini_swe_runner.py fix(kimi): omit temperature entirely for Kimi/Moonshot models (#13157) 2026-04-20 12:23:05 -07:00
model_tools.py fix(model_tools): log plugin hook exceptions instead of silently swallowing them 2026-05-07 05:33:31 -07:00
package-lock.json perf(browser): upgrade agent-browser 0.13 -> 0.26, wire daemon idle timeout 2026-04-22 16:33:36 -07:00
package.json perf(browser): upgrade agent-browser 0.13 -> 0.26, wire daemon idle timeout 2026-04-22 16:33:36 -07:00
pyproject.toml hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
README.md feat(windows-install): bundle portable MinGit instead of relying on winget 2026-05-08 14:27:40 -07:00
README.zh-CN.md docs: add Chinese (zh-CN) README translation 2026-05-05 14:15:05 -07:00
RELEASE_v0.2.0.md chore: rebuild changelog with correct time window (Feb 25 12PM PST onwards) 2026-03-12 02:33:50 -07:00
RELEASE_v0.3.0.md chore: release v0.3.0 (v2026.3.17) 2026-03-17 00:38:48 -07:00
RELEASE_v0.4.0.md docs: revise v0.4.0 changelog — fix feature attribution, reorder sections 2026-03-23 22:42:22 -07:00
RELEASE_v0.5.0.md chore: release v0.5.0 (v2026.3.28) (#3568) 2026-03-28 13:11:39 -07:00
RELEASE_v0.6.0.md chore: release v0.6.0 (2026.3.30) (#3985) 2026-03-30 08:29:38 -07:00
RELEASE_v0.7.0.md chore: release v0.7.0 (2026.4.3) (#4812) 2026-04-03 11:14:55 -07:00
RELEASE_v0.8.0.md docs: update v0.8.0 highlights — notify_on_complete, MiMo v2 Pro, reorder 2026-04-08 04:59:45 -07:00
RELEASE_v0.9.0.md fix: add contributor audit script + fix missed contributors (#9264) 2026-04-13 16:31:27 -07:00
RELEASE_v0.10.0.md chore: release v0.10.0 (2026.4.16) (#11209) 2026-04-16 12:53:06 -07:00
RELEASE_v0.11.0.md chore: release v0.11.0 (2026.4.23) (#14791) 2026-04-23 15:31:59 -07:00
RELEASE_v0.12.0.md chore: release v0.12.0 (2026.4.30) (#18057) 2026-04-30 11:31:01 -07:00
RELEASE_v0.13.0.md chore: release v0.13.0 (2026.5.7) (#21406) 2026-05-07 09:22:48 -07:00
rl_cli.py chore: remove unused imports and dead locals (ruff F401, F841) (#17010) 2026-04-28 06:46:45 -07:00
run_agent.py hermes_bootstrap: Windows-only UTF-8 stdio shim for all entry points 2026-05-08 14:27:40 -07:00
SECURITY.md docs: add terminal bypass test to Out of Scope section 2026-04-15 14:34:09 -07:00
setup-hermes.sh fix(installer): set UV_NO_CONFIG=1 to avoid permission denied under sudo -u 2026-05-07 15:21:34 -07:00
toolset_distributions.py chore: fix 154 f-strings, simplify getattr/URL patterns, remove dead code (#3119) 2026-03-25 19:47:58 -07:00
toolsets.py feat(computer-use): cua-driver backend, universal any-model schema 2026-05-08 11:07:38 -07:00
trajectory_compressor.py chore: remove unused imports and dead locals (ruff F401, F841) (#17010) 2026-04-28 06:46:45 -07:00
utils.py refactor: consolidate symlink-safe atomic replace into shared helper 2026-04-28 04:58:22 -07:00
uv.lock fix(install): remove uv exclude-newer cutoff 2026-05-07 05:29:47 -07:00

Hermes Agent

Hermes Agent ☤

Documentation Discord License: MIT Built by Nous Research 中文

The self-improving AI agent built by Nous Research. It's the only agent with a built-in learning loop — it creates skills from experience, improves them during use, nudges itself to persist knowledge, searches its own past conversations, and builds a deepening model of who you are across sessions. Run it on a $5 VPS, a GPU cluster, or serverless infrastructure that costs nearly nothing when idle. It's not tied to your laptop — talk to it from Telegram while it works on a cloud VM.

Use any model you want — Nous Portal, OpenRouter (200+ models), NVIDIA NIM (Nemotron), Xiaomi MiMo, z.ai/GLM, Kimi/Moonshot, MiniMax, Hugging Face, OpenAI, or your own endpoint. Switch with hermes model — no code changes, no lock-in.

A real terminal interfaceFull TUI with multiline editing, slash-command autocomplete, conversation history, interrupt-and-redirect, and streaming tool output.
Lives where you doTelegram, Discord, Slack, WhatsApp, Signal, and CLI — all from a single gateway process. Voice memo transcription, cross-platform conversation continuity.
A closed learning loopAgent-curated memory with periodic nudges. Autonomous skill creation after complex tasks. Skills self-improve during use. FTS5 session search with LLM summarization for cross-session recall. Honcho dialectic user modeling. Compatible with the agentskills.io open standard.
Scheduled automationsBuilt-in cron scheduler with delivery to any platform. Daily reports, nightly backups, weekly audits — all in natural language, running unattended.
Delegates and parallelizesSpawn isolated subagents for parallel workstreams. Write Python scripts that call tools via RPC, collapsing multi-step pipelines into zero-context-cost turns.
Runs anywhere, not just your laptopSeven terminal backends — local, Docker, SSH, Singularity, Modal, Daytona, and Vercel Sandbox. Daytona and Modal offer serverless persistence — your agent's environment hibernates when idle and wakes on demand, costing nearly nothing between sessions. Run it on a $5 VPS or a GPU cluster.
Research-readyBatch trajectory generation, Atropos RL environments, trajectory compression for training the next generation of tool-calling models.

Quick Install

Linux, macOS, WSL2, Termux

curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash

Windows (native, PowerShell)

Run this in PowerShell:

irm https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.ps1 | iex

The installer handles everything: uv, Python 3.11, Node.js, ripgrep, ffmpeg, and a portable Git Bash (MinGit, unpacked to %LOCALAPPDATA%\hermes\git — no admin required, completely isolated from any system Git install). Hermes uses this bundled Git Bash to run shell commands.

If you already have Git installed, the installer detects it and uses that instead. Otherwise a ~45MB MinGit download is all you need — it won't touch or interfere with any system Git.

Android / Termux: The tested manual path is documented in the Termux guide. On Termux, Hermes installs a curated .[termux] extra because the full .[all] extra currently pulls Android-incompatible voice dependencies.

Windows: Native Windows is supported — the PowerShell one-liner above installs everything. If you'd rather use WSL2, the Linux command works there too. Native Windows install lives under %LOCALAPPDATA%\hermes; WSL2 installs under ~/.hermes as on Linux. The only Hermes feature that currently needs WSL2 specifically is the browser-based dashboard chat pane (it uses a POSIX PTY — classic CLI and gateway both run natively).

After installation:

source ~/.bashrc    # reload shell (or: source ~/.zshrc)
hermes              # start chatting!

Getting Started

hermes              # Interactive CLI — start a conversation
hermes model        # Choose your LLM provider and model
hermes tools        # Configure which tools are enabled
hermes config set   # Set individual config values
hermes gateway      # Start the messaging gateway (Telegram, Discord, etc.)
hermes setup        # Run the full setup wizard (configures everything at once)
hermes claw migrate # Migrate from OpenClaw (if coming from OpenClaw)
hermes update       # Update to the latest version
hermes doctor       # Diagnose any issues

📖 Full documentation →

CLI vs Messaging Quick Reference

Hermes has two entry points: start the terminal UI with hermes, or run the gateway and talk to it from Telegram, Discord, Slack, WhatsApp, Signal, or Email. Once you're in a conversation, many slash commands are shared across both interfaces.

Action CLI Messaging platforms
Start chatting hermes Run hermes gateway setup + hermes gateway start, then send the bot a message
Start fresh conversation /new or /reset /new or /reset
Change model /model [provider:model] /model [provider:model]
Set a personality /personality [name] /personality [name]
Retry or undo the last turn /retry, /undo /retry, /undo
Compress context / check usage /compress, /usage, /insights [--days N] /compress, /usage, /insights [days]
Browse skills /skills or /<skill-name> /<skill-name>
Interrupt current work Ctrl+C or send a new message /stop or send a new message
Platform-specific status /platforms /status, /sethome

For the full command lists, see the CLI guide and the Messaging Gateway guide.


Documentation

All documentation lives at hermes-agent.nousresearch.com/docs:

Section What's Covered
Quickstart Install → setup → first conversation in 2 minutes
CLI Usage Commands, keybindings, personalities, sessions
Configuration Config file, providers, models, all options
Messaging Gateway Telegram, Discord, Slack, WhatsApp, Signal, Home Assistant
Security Command approval, DM pairing, container isolation
Tools & Toolsets 40+ tools, toolset system, terminal backends
Skills System Procedural memory, Skills Hub, creating skills
Memory Persistent memory, user profiles, best practices
MCP Integration Connect any MCP server for extended capabilities
Cron Scheduling Scheduled tasks with platform delivery
Context Files Project context that shapes every conversation
Architecture Project structure, agent loop, key classes
Contributing Development setup, PR process, code style
CLI Reference All commands and flags
Environment Variables Complete env var reference

Migrating from OpenClaw

If you're coming from OpenClaw, Hermes can automatically import your settings, memories, skills, and API keys.

During first-time setup: The setup wizard (hermes setup) automatically detects ~/.openclaw and offers to migrate before configuration begins.

Anytime after install:

hermes claw migrate              # Interactive migration (full preset)
hermes claw migrate --dry-run    # Preview what would be migrated
hermes claw migrate --preset user-data   # Migrate without secrets
hermes claw migrate --overwrite  # Overwrite existing conflicts

What gets imported:

  • SOUL.md — persona file
  • Memories — MEMORY.md and USER.md entries
  • Skills — user-created skills → ~/.hermes/skills/openclaw-imports/
  • Command allowlist — approval patterns
  • Messaging settings — platform configs, allowed users, working directory
  • API keys — allowlisted secrets (Telegram, OpenRouter, OpenAI, Anthropic, ElevenLabs)
  • TTS assets — workspace audio files
  • Workspace instructions — AGENTS.md (with --workspace-target)

See hermes claw migrate --help for all options, or use the openclaw-migration skill for an interactive agent-guided migration with dry-run previews.


Contributing

We welcome contributions! See the Contributing Guide for development setup, code style, and PR process.

Quick start for contributors — clone and go with setup-hermes.sh:

git clone https://github.com/NousResearch/hermes-agent.git
cd hermes-agent
./setup-hermes.sh     # installs uv, creates venv, installs .[all], symlinks ~/.local/bin/hermes
./hermes              # auto-detects the venv, no need to `source` first

Manual path (equivalent to the above):

curl -LsSf https://astral.sh/uv/install.sh | sh
uv venv .venv --python 3.11
source .venv/bin/activate
uv pip install -e ".[all,dev]"
scripts/run_tests.sh

RL Training (optional): The RL/Atropos integration (environments/) — see CONTRIBUTING.md for the full setup.


Community


License

MIT — see LICENSE.

Built by Nous Research.