Metadata-Version: 2.4
Name: hermes-agent-iot
Version: 0.20.0.post2
Summary: IoT and low-resource packaging of Hermes Agent, maintained as a native-compatible fork
Author: Nous Research
License-Expression: MIT
Project-URL: Homepage, https://github.com/matttest0080-prog/hermes-agent-iot
Project-URL: Repository, https://github.com/matttest0080-prog/hermes-agent-iot
Project-URL: Documentation, https://github.com/matttest0080-prog/hermes-agent-iot/blob/pi2-lite/README_PI2.md
Project-URL: Upstream project, https://github.com/NousResearch/hermes-agent
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openai==2.24.0
Requires-Dist: certifi==2026.5.20
Requires-Dist: python-dotenv==1.2.2
Requires-Dist: fire==0.7.1
Requires-Dist: httpx[socks]==0.28.1
Requires-Dist: rich==14.3.3
Requires-Dist: tenacity==9.1.4
Requires-Dist: pyyaml==6.0.3
Requires-Dist: ruamel.yaml==0.18.17
Requires-Dist: requests==2.33.0
Requires-Dist: jinja2==3.1.6
Requires-Dist: pydantic==2.13.4
Requires-Dist: prompt_toolkit==3.0.52
Requires-Dist: croniter==6.0.0
Requires-Dist: packaging==26.0
Requires-Dist: Markdown==3.10.2
Requires-Dist: PyJWT[crypto]==2.13.0
Requires-Dist: urllib3<3,>=2.7.0
Requires-Dist: cryptography<51,>=50.0.0
Requires-Dist: tzdata==2025.3; sys_platform == "win32"
Requires-Dist: psutil==7.2.2
Requires-Dist: websockets==15.0.1
Requires-Dist: pathspec==1.1.1
Requires-Dist: fastapi<1,>=0.104.0
Requires-Dist: uvicorn<1,>=0.24.0
Requires-Dist: python-multipart<1,>=0.0.9
Requires-Dist: ptyprocess<1,>=0.7.0; sys_platform != "win32"
Requires-Dist: pywinpty<3,>=2.0.0; sys_platform == "win32"
Requires-Dist: pywin32<312,>=306; sys_platform == "win32"
Requires-Dist: pywin32<312,>=306; sys_platform == "win32"
Requires-Dist: Pillow==12.3.0
Requires-Dist: concurrent-log-handler==0.9.29; sys_platform == "win32"
Requires-Dist: nemo-relay<0.7,>=0.6.0; (sys_platform == "darwin" and platform_machine == "arm64") or (sys_platform == "linux" and platform_machine == "x86_64" and "android" not in platform_release) or (sys_platform == "linux" and platform_machine == "aarch64" and "android" not in platform_release) or (sys_platform == "win32" and platform_machine == "AMD64") or (sys_platform == "win32" and platform_machine == "ARM64")
Provides-Extra: anthropic
Requires-Dist: anthropic==0.87.0; extra == "anthropic"
Provides-Extra: exa
Requires-Dist: exa-py==2.10.2; extra == "exa"
Provides-Extra: firecrawl
Requires-Dist: firecrawl-py==4.17.0; extra == "firecrawl"
Provides-Extra: parallel-web
Requires-Dist: parallel-web==0.4.2; extra == "parallel-web"
Provides-Extra: fal
Requires-Dist: fal-client==0.13.1; extra == "fal"
Provides-Extra: edge-tts
Requires-Dist: edge-tts==7.2.7; extra == "edge-tts"
Provides-Extra: modal
Requires-Dist: modal==1.3.4; extra == "modal"
Requires-Dist: cbor2==5.9.0; platform_machine == "armv7l" and extra == "modal"
Provides-Extra: daytona
Requires-Dist: daytona==0.155.0; extra == "daytona"
Provides-Extra: hindsight
Requires-Dist: hindsight-client==0.6.1; extra == "hindsight"
Provides-Extra: dev
Requires-Dist: hermes-agent-iot[full]==0.20.0.post2; extra == "dev"
Requires-Dist: debugpy==1.8.20; extra == "dev"
Requires-Dist: pytest==9.1.1; extra == "dev"
Requires-Dist: pytest-asyncio==1.3.0; extra == "dev"
Requires-Dist: mcp==1.28.1; extra == "dev"
Requires-Dist: starlette==1.3.1; extra == "dev"
Requires-Dist: ty==0.0.21; extra == "dev"
Requires-Dist: ruff==0.15.10; extra == "dev"
Requires-Dist: setuptools==83.0.0; extra == "dev"
Provides-Extra: messaging
Requires-Dist: python-telegram-bot[webhooks]==22.6; extra == "messaging"
Requires-Dist: discord.py==2.7.1; extra == "messaging"
Requires-Dist: PyNaCl==1.6.2; extra == "messaging"
Requires-Dist: davey==0.1.4; extra == "messaging"
Requires-Dist: aiohttp==3.14.3; extra == "messaging"
Requires-Dist: brotlicffi==1.2.0.1; extra == "messaging"
Requires-Dist: slack-bolt==1.29.0; extra == "messaging"
Requires-Dist: slack-sdk==3.43.0; extra == "messaging"
Requires-Dist: qrcode==7.4.2; extra == "messaging"
Provides-Extra: cron
Provides-Extra: slack
Requires-Dist: slack-bolt==1.29.0; extra == "slack"
Requires-Dist: slack-sdk==3.43.0; extra == "slack"
Requires-Dist: aiohttp==3.14.3; extra == "slack"
Provides-Extra: matrix
Requires-Dist: mautrix[encryption]==0.21.0; extra == "matrix"
Requires-Dist: aiosqlite==0.22.1; extra == "matrix"
Requires-Dist: asyncpg==0.31.0; extra == "matrix"
Requires-Dist: aiohttp-socks==0.11.0; extra == "matrix"
Requires-Dist: aiohttp==3.14.3; extra == "matrix"
Provides-Extra: wecom
Requires-Dist: defusedxml==0.7.1; extra == "wecom"
Provides-Extra: cli
Requires-Dist: simple-term-menu==1.6.6; extra == "cli"
Provides-Extra: tts-premium
Requires-Dist: elevenlabs==1.59.0; extra == "tts-premium"
Provides-Extra: voice
Requires-Dist: faster-whisper==1.2.1; extra == "voice"
Requires-Dist: sounddevice==0.5.5; extra == "voice"
Requires-Dist: numpy==2.4.3; extra == "voice"
Provides-Extra: wake
Requires-Dist: openwakeword==0.6.0; extra == "wake"
Requires-Dist: onnxruntime==1.27.0; extra == "wake"
Requires-Dist: sherpa-onnx==1.13.4; extra == "wake"
Requires-Dist: sentencepiece==0.2.2; extra == "wake"
Requires-Dist: pvporcupine==4.0.3; extra == "wake"
Requires-Dist: sounddevice==0.5.5; extra == "wake"
Requires-Dist: numpy==2.4.3; extra == "wake"
Requires-Dist: ai-edge-litert==2.1.6; platform_system == "Darwin" and extra == "wake"
Provides-Extra: honcho
Requires-Dist: honcho-ai==2.2.0; extra == "honcho"
Provides-Extra: supermemory
Requires-Dist: supermemory==3.50.0; extra == "supermemory"
Provides-Extra: mem0
Requires-Dist: mem0ai==2.0.10; extra == "mem0"
Provides-Extra: vision
Provides-Extra: pty
Provides-Extra: mcp
Requires-Dist: mcp==1.28.1; extra == "mcp"
Requires-Dist: starlette==1.3.1; extra == "mcp"
Provides-Extra: nemo-relay
Provides-Extra: homeassistant
Requires-Dist: aiohttp==3.14.3; extra == "homeassistant"
Provides-Extra: mqtt
Requires-Dist: paho-mqtt==2.1.0; extra == "mqtt"
Provides-Extra: sms
Requires-Dist: aiohttp==3.14.3; extra == "sms"
Provides-Extra: teams
Requires-Dist: microsoft-teams-apps==2.0.13.4; extra == "teams"
Requires-Dist: aiohttp==3.14.3; extra == "teams"
Provides-Extra: computer-use
Requires-Dist: mcp==1.28.1; extra == "computer-use"
Requires-Dist: starlette==1.3.1; extra == "computer-use"
Provides-Extra: acp
Requires-Dist: agent-client-protocol==0.9.0; extra == "acp"
Provides-Extra: mistral
Requires-Dist: mistralai==2.4.8; extra == "mistral"
Provides-Extra: otlp
Requires-Dist: opentelemetry-sdk==1.39.1; extra == "otlp"
Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.39.1; extra == "otlp"
Provides-Extra: bedrock
Requires-Dist: boto3==1.42.89; extra == "bedrock"
Provides-Extra: vertex
Requires-Dist: google-auth==2.55.1; extra == "vertex"
Provides-Extra: azure-identity
Requires-Dist: azure-identity==1.25.3; extra == "azure-identity"
Provides-Extra: termux
Requires-Dist: python-telegram-bot[webhooks]==22.6; extra == "termux"
Requires-Dist: hermes-agent-iot[cron]==0.20.0.post2; extra == "termux"
Requires-Dist: hermes-agent-iot[cli]==0.20.0.post2; extra == "termux"
Requires-Dist: hermes-agent-iot[mcp]==0.20.0.post2; extra == "termux"
Requires-Dist: hermes-agent-iot[honcho]==0.20.0.post2; extra == "termux"
Requires-Dist: hermes-agent-iot[acp]==0.20.0.post2; extra == "termux"
Provides-Extra: termux-all
Requires-Dist: hermes-agent-iot[termux]==0.20.0.post2; extra == "termux-all"
Requires-Dist: hermes-agent-iot[google]==0.20.0.post2; extra == "termux-all"
Requires-Dist: hermes-agent-iot[homeassistant]==0.20.0.post2; extra == "termux-all"
Requires-Dist: hermes-agent-iot[sms]==0.20.0.post2; extra == "termux-all"
Requires-Dist: hermes-agent-iot[web]==0.20.0.post2; extra == "termux-all"
Requires-Dist: hermes-agent-iot[pty]==0.20.0.post2; extra == "termux-all"
Provides-Extra: dingtalk
Requires-Dist: dingtalk-stream==0.24.3; extra == "dingtalk"
Requires-Dist: alibabacloud-dingtalk==2.2.42; extra == "dingtalk"
Requires-Dist: qrcode==7.4.2; extra == "dingtalk"
Provides-Extra: feishu
Requires-Dist: lark-oapi==1.6.8; extra == "feishu"
Requires-Dist: qrcode==7.4.2; extra == "feishu"
Provides-Extra: google
Requires-Dist: google-api-python-client==2.194.0; extra == "google"
Requires-Dist: google-auth==2.55.1; extra == "google"
Requires-Dist: google-auth-oauthlib==1.3.1; extra == "google"
Requires-Dist: google-auth-httplib2==0.3.1; extra == "google"
Requires-Dist: httplib2==0.32.0; extra == "google"
Requires-Dist: pyasn1==0.6.4; extra == "google"
Provides-Extra: youtube
Requires-Dist: youtube-transcript-api==1.2.4; extra == "youtube"
Provides-Extra: web
Requires-Dist: fastapi==0.133.1; extra == "web"
Requires-Dist: uvicorn==0.41.0; extra == "web"
Requires-Dist: starlette==1.3.1; extra == "web"
Requires-Dist: python-multipart==0.0.32; extra == "web"
Provides-Extra: all
Requires-Dist: hermes-agent-iot[cron]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[cli]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[pty]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[mcp]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[homeassistant]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[sms]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[acp]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[google]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[web]==0.20.0.post2; extra == "all"
Requires-Dist: hermes-agent-iot[youtube]==0.20.0.post2; extra == "all"
Provides-Extra: minimal
Requires-Dist: hermes-agent-iot[cli,pty]==0.20.0.post2; extra == "minimal"
Provides-Extra: iot
Requires-Dist: hermes-agent-iot[acp,homeassistant,mcp,minimal,mqtt,sms]==0.20.0.post2; extra == "iot"
Provides-Extra: rag
Requires-Dist: hermes-agent-iot[honcho,iot]==0.20.0.post2; extra == "rag"
Provides-Extra: full
Requires-Dist: hermes-agent-iot[all]==0.20.0.post2; extra == "full"
Dynamic: license-file

<p align="center">
  <img src="assets/banner.png" alt="Hermes Agent" width="100%">
</p>

# Hermes Agent ☤
<p align="center">
  <a href="https://hermes-agent.nousresearch.com/">Hermes Agent</a> | <a href="https://hermes-agent.nousresearch.com/">Hermes Desktop</a>
</p>
<p align="center">
  <a href="https://hermes-agent.nousresearch.com/docs/"><img src="https://img.shields.io/badge/Docs-hermes--agent.nousresearch.com-FFD700?style=for-the-badge" alt="Documentation"></a>
  <a href="https://discord.gg/NousResearch"><img src="https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Discord"></a>
  <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge" alt="License: MIT"></a>
  <a href="https://nousresearch.com"><img src="https://img.shields.io/badge/Upstream-Nous%20Research-blueviolet?style=for-the-badge" alt="Upstream by Nous Research"></a>
  <a href="https://github.com/matttest0080-prog"><img src="https://img.shields.io/badge/IoT%20fork-matttest0080--prog-orange?style=for-the-badge" alt="IoT fork maintained by matttest0080-prog"></a>
  <a href="README.zh-CN.md"><img src="https://img.shields.io/badge/Lang-中文-red?style=for-the-badge" alt="中文"></a>
  <a href="README.ur-pk.md"><img src="https://img.shields.io/badge/Lang-اردو-green?style=for-the-badge" alt="اردو"></a>
  <a href="README.es.md"><img src="https://img.shields.io/badge/Lang-Español-orange?style=for-the-badge" alt="Español"></a>
</p>

**The self-improving AI agent built by [Nous Research](https://nousresearch.com).** 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](https://portal.nousresearch.com), OpenRouter, OpenAI, your own endpoint, and [many others](https://hermes-agent.nousresearch.com/docs/integrations/providers). Switch with `hermes model` — no code changes, no lock-in.

<table>
<tr><td><b>A real terminal interface</b></td><td>Full TUI with multiline editing, slash-command autocomplete, conversation history, interrupt-and-redirect, and streaming tool output.</td></tr>
<tr><td><b>Lives where you do</b></td><td>Telegram, Discord, Slack, WhatsApp, Signal, and CLI — all from a single gateway process. Voice memo transcription, cross-platform conversation continuity.</td></tr>
<tr><td><b>A closed learning loop</b></td><td>Agent-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. <a href="https://github.com/plastic-labs/honcho">Honcho</a> dialectic user modeling. Compatible with the <a href="https://agentskills.io">agentskills.io</a> open standard.</td></tr>
<tr><td><b>Scheduled automations</b></td><td>Built-in cron scheduler with delivery to any platform. Daily reports, nightly backups, weekly audits — all in natural language, running unattended.</td></tr>
<tr><td><b>Delegates and parallelizes</b></td><td>Spawn isolated subagents for parallel workstreams. Write Python scripts that call tools via RPC, collapsing multi-step pipelines into zero-context-cost turns.</td></tr>
<tr><td><b>Runs anywhere, not just your laptop</b></td><td>Seven 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.</td></tr>
<tr><td><b>Research-ready</b></td><td>Batch trajectory generation, trajectory compression for training the next generation of tool-calling models.</td></tr>
</table>

---

## Quick Install

### Raspberry Pi 2 / IoT — this fork

For Raspberry Pi 2, ARMv7, low-resource edge nodes, MQTT device control, or
remote-first RAG, install the maintained `pi2-lite` branch from this repository:

```bash
git clone --branch pi2-lite --depth 1 \
  https://github.com/matttest0080-prog/hermes-agent-iot.git
cd hermes-agent-iot
bash setup-pi2-minimal.sh --profile minimal
source ~/.hermes-venv/bin/activate
hermes setup model
hermes
```

> **Keep the clone directory.** The Pi2 installer uses an editable Python
> installation (`pip install -e`), so the installed `hermes` command continues
> to reference this checkout. Moving or deleting `hermes-agent-iot` can break
> the environment.

Previous source-deployment snapshot (before the `0.20.0.post1` PyPI packaging
work in this branch):

- source version: `0.20.0`
- upstream merge commit: `4f1082ba14`
- security release commit: `af60caf08`
- deployment branch: `pi2-lite`

The fork may intentionally lag the fast-moving upstream `main` while IoT
patches, dependency changes and ARMv7 compatibility are reviewed. The version
number alone does not mean that every newer upstream commit is already present.

#### Install profiles

Three similarly named concepts are intentionally separate:

- **Install profiles** (`hermes-iot setup --profile ...`) select one packaged
  configuration template and record the choice; they never run pip or overwrite
  an existing `~/.hermes/config.yaml`.
- **PyPI extras** (`hermes-agent-iot[minimal]`, `[iot]`, `[rag]`, `[full]`,
  `[dev]`) select dependency sets. Install into a virtual environment first,
  then run `hermes-iot setup --profile NAME`.
- **Hermes instance profiles** (`hermes profile ...`) are independent runtime
  homes/configurations and are unrelated to package installation profiles.

Example PyPI path: `python -m pip install 'hermes-agent-iot[iot]'`, followed by
`hermes-iot setup --profile iot`. `full` and `dev` target stronger hosts and are
not suitable for Raspberry Pi 2 / 1 GB systems.

The initial PyPI wheel contains the Python runtime, CLI entry points, Python
plugin modules, and the four profile configuration templates. Repository-level
bundled/optional skills, optional MCP catalogs, Desktop/TUI/Web build artifacts,
and other source-tree assets are intentionally not copied into the lightweight
wheel. Use the branch-specific Git clone installer when those assets are
required. In PyPI terminology, `full` and `dev` describe dependency sets; they
do not turn the wheel into a Desktop bundle.

Consequently, the wheel does not provide the repository's official skills
catalog, optional MCP catalog, non-English locale catalog, Dashboard bundle, or
prebuilt TUI bundle. Catalog browsing/install commands, localized UI,
Dashboard/TUI startup, and source/frontend development require the `pi2-lite`
Git checkout. These features are not silently downloaded by `hermes-iot setup`.

The wheel build and clean-install smoke tests currently run on x86_64 Linux.
They do not constitute physical Raspberry Pi 2 / ARMv7 validation. Do not treat
the first PyPI artifact as a verified Pi2 support claim until the same released
wheel has completed a clean install and runtime smoke test on physical Pi2
hardware.

The initial release publishes the universal wheel only. It does not publish an
sdist whose installation could depend on a source checkout and its release
build marker.

Choose the profile that matches the target device and workload:

```bash
bash setup-pi2-minimal.sh --profile minimal  # Pi2 / ARMv7 / 1GB RAM baseline
bash setup-pi2-minimal.sh --profile iot      # MQTT, Home Assistant, MCP/ACP and SMS
bash setup-pi2-minimal.sh --profile rag      # IoT + Honcho; remote-first RAG
bash setup-pi2-minimal.sh --profile full     # Stronger Pi, ARM64, x86 edge server or VM
bash setup-pi2-minimal.sh --profile dev      # Full profile + development/test tooling
```

- `minimal`: smallest practical Hermes CLI installation for Raspberry Pi 2.
- `iot`: adds MQTT, Home Assistant, MCP, ACP and SMS integrations.
- `rag`: adds Honcho and a remote-first RAG configuration; local heavy embedding
  stacks are not installed by default.
- `full`: installs the broader Hermes feature set and is not recommended for
  Raspberry Pi 2 or other 1 GB systems.
- `dev`: installs full and developer/test dependencies; intended for contributor
  machines rather than production edge nodes.

Backward-compatible aliases remain available: `core` → `minimal` and
`native` → `iot`.

See [README_PI2.md](README_PI2.md) for the complete dependency matrix,
configuration templates and safety guidance.

#### Updating this Pi2 / IoT fork

The Pi2 installer uses an editable checkout and profile-specific dependency
sets. The examples below assume the repository was cloned into
`~/hermes-agent-iot`; if you used another clone directory, replace that path.
The `hermes` executable is installed in the Pi2 virtual environment created by
the installer. Opening the repository directory alone does **not** put it on
`PATH`; activate the environment before running any `hermes` command:

```bash
cd ~/hermes-agent-iot
source ~/.hermes-venv/bin/activate
command -v hermes
hermes --version
```

If Bash reports `hermes: command not found`, the virtual environment is not
active. Run the activation command above. If `~/.hermes-venv/bin/activate`
does not exist, complete the profile installation first:

```bash
bash setup-pi2-minimal.sh --profile minimal
source ~/.hermes-venv/bin/activate
```

Preview an update with the branch explicitly selected:

```bash
hermes update --check --branch pi2-lite
```

The CLI may print the generic message `Run 'hermes update' to install.`
That message is not branch-safe for this Pi2 fork. Do **not** run the bare
command; continue to use the explicit `pi2-lite` branch shown below.

For an actual Pi2 update, use the branch-safe git procedure and rerun the same
profile installer so the low-resource dependency set is restored:

```bash
cd ~/hermes-agent-iot

# Review local changes first; do not update a dirty checkout blindly.
git status --short

# Explicitly select the Pi2 branch before fetching or merging.
git switch pi2-lite
git fetch origin pi2-lite
git merge --ff-only origin/pi2-lite

source ~/.hermes-venv/bin/activate
bash setup-pi2-minimal.sh --profile minimal

# Verify that the checkout stayed on the Pi2 branch.
test "$(git branch --show-current)" = "pi2-lite"
git status --short
```

Replace `minimal` with the profile originally installed (`iot`, `rag`, `full`
or `dev`). The generic `hermes update --branch pi2-lite` command is not the
preferred Pi2 profile update path because Hermes updates reinstall the broader
dependency group; if you use it, rerun the original profile installer
afterwards. Never run a bare `hermes update` here: its default target is
`main`, not `pi2-lite`. Review or preserve local changes before pulling; do not
use a hard reset as a routine update method.

### Upstream Hermes full installer

The installers below install the official `NousResearch/hermes-agent` build.
Use them for general desktop/server installations; they do **not** install this
fork's Pi2 profiles or MQTT additions.

### Linux, macOS, WSL2, Termux

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

### Windows (native, PowerShell)

> **Heads up:** Native Windows runs Hermes without WSL — CLI, gateway, TUI, and tools all work natively. If you'd rather use WSL2, the Linux/macOS one-liner above works there too. Found a bug? Please [file issues](https://github.com/NousResearch/hermes-agent/issues).

Run this in PowerShell:

```powershell
iex (irm https://hermes-agent.nousresearch.com/install.ps1)
```

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](https://hermes-agent.nousresearch.com/docs/getting-started/termux). On Termux, Hermes installs a curated `.[termux]` extra because the full `.[all]` extra currently pulls Android-incompatible voice dependencies.
>
> **Windows:** Native Windows is fully 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.

After installation:

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

### Troubleshooting

#### Windows Defender or antivirus flags `uv.exe` as malware

If your antivirus (Bitdefender, Windows Defender, etc.) quarantines `uv.exe` from the Hermes `bin` folder (`%LOCALAPPDATA%\hermes\bin\uv.exe`), this is a **false positive**. The file is Astral's `uv` — the Rust Python package manager Hermes bundles to manage its Python environment. ML-based antivirus engines commonly flag unsigned Rust binaries that download and install packages.

**To verify your copy is authentic:**

```powershell
# Install GitHub CLI if needed
winget install --id GitHub.cli

# Login to GitHub
gh auth login

# Run verification
$uv = "$env:LOCALAPPDATA\hermes\bin\uv.exe"
$ver = (& $uv --version).Split(' ')[1]
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$zip = "$env:TEMP\uv.zip"
Invoke-WebRequest "https://github.com/astral-sh/uv/releases/download/$ver/uv-x86_64-pc-windows-msvc.zip" -OutFile $zip -UseBasicParsing
gh attestation verify $zip --repo astral-sh/uv
Expand-Archive $zip "$env:TEMP\uv_x" -Force
(Get-FileHash "$env:TEMP\uv_x\uv.exe").Hash -eq (Get-FileHash $uv).Hash
```

If attestation says "Verification succeeded" and the last line prints `True`, you're good.

**To whitelist Hermes:**
- **Windows Defender:** Run PowerShell as Admin → `Add-MpPreference -ExclusionPath "$env:LOCALAPPDATA\hermes\bin"`
- **Bitdefender:** Add an exception in the Bitdefender console (Protection > Antivirus > Settings > Manage Exceptions)
- Whitelist the **folder**, not the file hash — Hermes updates `uv` and the hash changes every version

For more context, see the upstream Astral reports: [astral-sh/uv#13553](https://github.com/astral-sh/uv/issues/13553), [astral-sh/uv#15011](https://github.com/astral-sh/uv/issues/15011), [astral-sh/uv#10079](https://github.com/astral-sh/uv/issues/10079).

---

## Getting Started

```bash
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 config get   # Print 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       # Official managed installs; Pi2 fork users: see update instructions above
hermes doctor       # Diagnose any issues
```

📖 **[Full documentation →](https://hermes-agent.nousresearch.com/docs/)**

---

## Skip the API-key collection — Nous Portal

Hermes works with whatever provider you want — that's not changing. But if you'd rather not collect five separate API keys for the model, web search, image generation, TTS, and a cloud browser, **[Nous Portal](https://portal.nousresearch.com)** covers all of them under one subscription:

- **300+ models** — pick any of them with `/model <name>`
- **Tool Gateway** — web search (Firecrawl), image generation (FAL), text-to-speech (OpenAI), cloud browser (Browser Use), all routed through your sub. No extra accounts.

One command from a fresh install:

```bash
hermes setup --portal
```

That logs you in via OAuth, sets Nous as your provider, and turns on the Tool Gateway. Check what's wired up any time with `hermes portal info`. Full details on the [Tool Gateway docs page](https://hermes-agent.nousresearch.com/docs/user-guide/features/tool-gateway).

You can still bring your own keys per-tool whenever you want — the gateway is per-backend, not all-or-nothing.

---

## 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](https://hermes-agent.nousresearch.com/docs/user-guide/cli) and the [Messaging Gateway guide](https://hermes-agent.nousresearch.com/docs/user-guide/messaging).

---

## Documentation

Upstream Hermes documentation lives at **[hermes-agent.nousresearch.com/docs](https://hermes-agent.nousresearch.com/docs/)**. This IoT fork adds the local Pi2 and robotics guides listed below.

| Section                                                                                             | What's Covered                                             |
| --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [Quickstart](https://hermes-agent.nousresearch.com/docs/getting-started/quickstart)                 | Install → setup → first conversation in 2 minutes          |
| [CLI Usage](https://hermes-agent.nousresearch.com/docs/user-guide/cli)                              | Commands, keybindings, personalities, sessions             |
| [Configuration](https://hermes-agent.nousresearch.com/docs/user-guide/configuration)                | Config file, providers, models, all options                |
| [Messaging Gateway](https://hermes-agent.nousresearch.com/docs/user-guide/messaging)                | Telegram, Discord, Slack, WhatsApp, Signal, Home Assistant |
| [Security](https://hermes-agent.nousresearch.com/docs/user-guide/security)                          | Command approval, DM pairing, container isolation          |
| [Tools & Toolsets](https://hermes-agent.nousresearch.com/docs/user-guide/features/tools)            | 40+ tools, toolset system, terminal backends               |
| [Skills System](https://hermes-agent.nousresearch.com/docs/user-guide/features/skills)              | Procedural memory, Skills Hub, creating skills             |
| [Memory](https://hermes-agent.nousresearch.com/docs/user-guide/features/memory)                     | Persistent memory, user profiles, best practices           |
| [MCP Integration](https://hermes-agent.nousresearch.com/docs/user-guide/features/mcp)               | Connect any MCP server for extended capabilities           |
| [Cron Scheduling](https://hermes-agent.nousresearch.com/docs/user-guide/features/cron)              | Scheduled tasks with platform delivery                     |
| [Context Files](https://hermes-agent.nousresearch.com/docs/user-guide/features/context-files)       | Project context that shapes every conversation             |
| [Architecture](https://hermes-agent.nousresearch.com/docs/developer-guide/architecture)             | Project structure, agent loop, key classes                 |
| [Contributing](https://hermes-agent.nousresearch.com/docs/developer-guide/contributing)             | Development setup, PR process, code style                  |
| [CLI Reference](https://hermes-agent.nousresearch.com/docs/reference/cli-commands)                  | All commands and flags                                     |
| [Environment Variables](https://hermes-agent.nousresearch.com/docs/reference/environment-variables) | Complete env var reference                                 |

### Raspberry Pi 2 and IoT profiles

This fork also carries opt-in low-resource profiles while preserving the
upstream Agent, Gateway, tool, plugin, memory, cron, MCP, and ACP architecture:

- [Pi2 quickstart and profile guide](README_PI2.md)
- [Detailed Raspberry Pi 2 manual](RASPBERRY_PI2_MANUAL.md)
- [Robotics architecture and safety guidance](ROBOTICS.md)

Start with `bash setup-pi2-minimal.sh --profile minimal`, or select `iot` or
`rag` for MQTT/Home Assistant and remote-first RAG dependencies. Heavy browser,
media, local embedding, and desktop surfaces remain opt-in on constrained hosts.

---

## 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:**

```bash
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](https://hermes-agent.nousresearch.com/docs/developer-guide/contributing) for development setup, code style, and PR process.

Quick start for contributors — use the standard installer, then work from the
full git checkout it creates at `$HERMES_HOME/hermes-agent` (usually
`~/.hermes/hermes-agent`). This matches the layout used by `hermes update`, the
managed venv, lazy dependencies, gateway, and docs tooling.

```bash
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
cd "${HERMES_HOME:-$HOME/.hermes}/hermes-agent"
uv pip install -e ".[all,dev]"
scripts/run_tests.sh
```

Manual clone fallback (for throwaway clones/CI where you intentionally do not
want the managed install layout):

Create the venv outside the cloned source tree — a venv inside the directory
the agent operates from can be wiped by a relative-path command the agent runs
against its own checkout, destroying the running runtime mid-session.

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

---

## Community

- 💬 [Discord](https://discord.gg/NousResearch)
- 📚 [Skills Hub](https://agentskills.io)
- 🐛 [Issues](https://github.com/NousResearch/hermes-agent/issues)
- 🔌 [computer-use-linux](https://github.com/avifenesh/computer-use-linux) — Linux desktop-control MCP server for Hermes and other MCP hosts, with AT-SPI accessibility trees, Wayland/X11 input, screenshots, and compositor window targeting.
- 🔌 [HermesClaw](https://github.com/AaronWong1999/hermesclaw) — Community WeChat bridge: Run Hermes Agent and OpenClaw on the same WeChat account.

---

## License

MIT — see [LICENSE](LICENSE).

Upstream Hermes Agent is built by [Nous Research](https://nousresearch.com).
This Raspberry Pi / IoT fork is maintained by
[matttest0080-prog](https://github.com/matttest0080-prog).

Bundled plugins, skills and third-party components may include their own
license or notice files; those terms apply to the corresponding components.
