mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-27 01:11:40 +00:00
feat: add tested Termux install path and EOF-aware gh auth
This commit is contained in:
parent
e053433c84
commit
e79cc88985
15 changed files with 724 additions and 23 deletions
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
title: "Installation"
|
||||
description: "Install Hermes Agent on Linux, macOS, or WSL2"
|
||||
description: "Install Hermes Agent on Linux, macOS, WSL2, or Android via Termux"
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
|
@ -16,6 +16,23 @@ Get Hermes Agent up and running in under two minutes with the one-line installer
|
|||
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
|
||||
```
|
||||
|
||||
### Android / Termux
|
||||
|
||||
Hermes now ships a Termux-aware installer path too:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
|
||||
```
|
||||
|
||||
The installer detects Termux automatically and switches to a tested Android flow:
|
||||
- uses Termux `pkg` for system dependencies (`git`, `python`, `nodejs`, `ripgrep`, `ffmpeg`, build tools)
|
||||
- creates the virtualenv with `python -m venv`
|
||||
- exports `ANDROID_API_LEVEL` automatically for Android wheel builds
|
||||
- installs a curated `.[termux]` extra with `pip`
|
||||
- skips the untested browser / WhatsApp bootstrap by default
|
||||
|
||||
If you want the fully explicit path, follow the dedicated [Termux guide](./termux.md).
|
||||
|
||||
:::warning Windows
|
||||
Native Windows is **not supported**. Please install [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) and run Hermes Agent from there. The install command above works inside WSL2.
|
||||
:::
|
||||
|
|
@ -125,6 +142,7 @@ uv pip install -e "."
|
|||
| `tts-premium` | ElevenLabs premium voices | `uv pip install -e ".[tts-premium]"` |
|
||||
| `voice` | CLI microphone input + audio playback | `uv pip install -e ".[voice]"` |
|
||||
| `pty` | PTY terminal support | `uv pip install -e ".[pty]"` |
|
||||
| `termux` | Tested Android / Termux bundle (`cron`, `cli`, `pty`, `mcp`, `honcho`, `acp`) | `python -m pip install -e ".[termux]" -c constraints-termux.txt` |
|
||||
| `honcho` | AI-native memory (Honcho integration) | `uv pip install -e ".[honcho]"` |
|
||||
| `mcp` | Model Context Protocol support | `uv pip install -e ".[mcp]"` |
|
||||
| `homeassistant` | Home Assistant integration | `uv pip install -e ".[homeassistant]"` |
|
||||
|
|
@ -134,6 +152,10 @@ uv pip install -e "."
|
|||
|
||||
You can combine extras: `uv pip install -e ".[messaging,cron]"`
|
||||
|
||||
:::tip Termux users
|
||||
`.[all]` is not currently available on Android because the `voice` extra pulls `faster-whisper`, which depends on `ctranslate2` wheels that are not published for Android. Use `.[termux]` for the tested mobile install path, then add individual extras only as needed.
|
||||
:::
|
||||
|
||||
</details>
|
||||
|
||||
### Step 4: Install Optional Submodules (if needed)
|
||||
|
|
|
|||
|
|
@ -13,10 +13,14 @@ This guide walks you through installing Hermes Agent, setting up a provider, and
|
|||
Run the one-line installer:
|
||||
|
||||
```bash
|
||||
# Linux / macOS / WSL2
|
||||
# Linux / macOS / WSL2 / Android (Termux)
|
||||
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
|
||||
```
|
||||
|
||||
:::tip Android / Termux
|
||||
If you're installing on a phone, see the dedicated [Termux guide](./termux.md) for the tested manual path, supported extras, and current Android-specific limitations.
|
||||
:::
|
||||
|
||||
:::tip Windows Users
|
||||
Install [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) first, then run the command above inside your WSL2 terminal.
|
||||
:::
|
||||
|
|
|
|||
228
website/docs/getting-started/termux.md
Normal file
228
website/docs/getting-started/termux.md
Normal file
|
|
@ -0,0 +1,228 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
title: "Android / Termux"
|
||||
description: "Run Hermes Agent directly on an Android phone with Termux"
|
||||
---
|
||||
|
||||
# Hermes on Android with Termux
|
||||
|
||||
This is the tested path for running Hermes Agent directly on an Android phone through [Termux](https://termux.dev/).
|
||||
|
||||
It gives you a working local CLI on the phone, plus the core extras that are currently known to install cleanly on Android.
|
||||
|
||||
## What is supported in the tested path?
|
||||
|
||||
The tested Termux bundle installs:
|
||||
- the Hermes CLI
|
||||
- cron support
|
||||
- PTY/background terminal support
|
||||
- MCP support
|
||||
- Honcho memory support
|
||||
- ACP support
|
||||
|
||||
Concretely, it maps to:
|
||||
|
||||
```bash
|
||||
python -m pip install -e '.[termux]' -c constraints-termux.txt
|
||||
```
|
||||
|
||||
## What is not part of the tested path yet?
|
||||
|
||||
A few features still need desktop/server-style dependencies that are not published for Android, or have not been validated on phones yet:
|
||||
|
||||
- `.[all]` is not supported on Android today
|
||||
- the `voice` extra is blocked by `faster-whisper -> ctranslate2`, and `ctranslate2` does not publish Android wheels
|
||||
- automatic browser / Playwright bootstrap is skipped in the Termux installer
|
||||
- Docker-based terminal isolation is not available inside Termux
|
||||
|
||||
That does not stop Hermes from working well as a phone-native CLI agent — it just means the recommended mobile install is intentionally narrower than the desktop/server install.
|
||||
|
||||
---
|
||||
|
||||
## Option 1: One-line installer
|
||||
|
||||
Hermes now ships a Termux-aware installer path:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
|
||||
```
|
||||
|
||||
On Termux, the installer automatically:
|
||||
- uses `pkg` for system packages
|
||||
- creates the venv with `python -m venv`
|
||||
- installs `.[termux]` with `pip`
|
||||
- skips the untested browser / WhatsApp bootstrap
|
||||
|
||||
If you want the explicit commands or need to debug a failed install, use the manual path below.
|
||||
|
||||
---
|
||||
|
||||
## Option 2: Manual install (fully explicit)
|
||||
|
||||
### 1. Update Termux and install system packages
|
||||
|
||||
```bash
|
||||
pkg update
|
||||
pkg install -y git python clang rust make pkg-config libffi openssl nodejs ripgrep ffmpeg
|
||||
```
|
||||
|
||||
Why these packages?
|
||||
- `python` — runtime + venv support
|
||||
- `git` — clone/update the repo
|
||||
- `clang`, `rust`, `make`, `pkg-config`, `libffi`, `openssl` — needed to build a few Python dependencies on Android
|
||||
- `nodejs` — optional Node runtime for experiments beyond the tested core path
|
||||
- `ripgrep` — fast file search
|
||||
- `ffmpeg` — media / TTS conversions
|
||||
|
||||
### 2. Clone Hermes
|
||||
|
||||
```bash
|
||||
git clone --recurse-submodules https://github.com/NousResearch/hermes-agent.git
|
||||
cd hermes-agent
|
||||
```
|
||||
|
||||
If you already cloned without submodules:
|
||||
|
||||
```bash
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
### 3. Create a virtual environment
|
||||
|
||||
```bash
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
export ANDROID_API_LEVEL="$(getprop ro.build.version.sdk)"
|
||||
python -m pip install --upgrade pip setuptools wheel
|
||||
```
|
||||
|
||||
`ANDROID_API_LEVEL` is important for Rust / maturin-based packages such as `jiter`.
|
||||
|
||||
### 4. Install the tested Termux bundle
|
||||
|
||||
```bash
|
||||
python -m pip install -e '.[termux]' -c constraints-termux.txt
|
||||
```
|
||||
|
||||
If you only want the minimal core agent, this also works:
|
||||
|
||||
```bash
|
||||
python -m pip install -e '.' -c constraints-termux.txt
|
||||
```
|
||||
|
||||
### 5. Verify the install
|
||||
|
||||
```bash
|
||||
hermes version
|
||||
hermes doctor
|
||||
```
|
||||
|
||||
### 6. Start Hermes
|
||||
|
||||
```bash
|
||||
hermes
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Recommended follow-up setup
|
||||
|
||||
### Configure a model
|
||||
|
||||
```bash
|
||||
hermes model
|
||||
```
|
||||
|
||||
Or set keys directly in `~/.hermes/.env`.
|
||||
|
||||
### Re-run the full interactive setup wizard later
|
||||
|
||||
```bash
|
||||
hermes setup
|
||||
```
|
||||
|
||||
### Install optional Node dependencies manually
|
||||
|
||||
The tested Termux path skips Node/browser bootstrap on purpose. If you want to experiment later:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
Treat browser / WhatsApp tooling on Android as experimental until documented otherwise.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### `No solution found` when installing `.[all]`
|
||||
|
||||
Use the tested Termux bundle instead:
|
||||
|
||||
```bash
|
||||
python -m pip install -e '.[termux]' -c constraints-termux.txt
|
||||
```
|
||||
|
||||
The blocker is currently the `voice` extra:
|
||||
- `voice` pulls `faster-whisper`
|
||||
- `faster-whisper` depends on `ctranslate2`
|
||||
- `ctranslate2` does not publish Android wheels
|
||||
|
||||
### `uv pip install` fails on Android
|
||||
|
||||
Use the Termux path with the stdlib venv + `pip` instead:
|
||||
|
||||
```bash
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
export ANDROID_API_LEVEL="$(getprop ro.build.version.sdk)"
|
||||
python -m pip install --upgrade pip setuptools wheel
|
||||
python -m pip install -e '.[termux]' -c constraints-termux.txt
|
||||
```
|
||||
|
||||
### `jiter` / `maturin` complains about `ANDROID_API_LEVEL`
|
||||
|
||||
Set the API level explicitly before installing:
|
||||
|
||||
```bash
|
||||
export ANDROID_API_LEVEL="$(getprop ro.build.version.sdk)"
|
||||
python -m pip install -e '.[termux]' -c constraints-termux.txt
|
||||
```
|
||||
|
||||
### `hermes doctor` says ripgrep or Node is missing
|
||||
|
||||
Install them with Termux packages:
|
||||
|
||||
```bash
|
||||
pkg install ripgrep nodejs
|
||||
```
|
||||
|
||||
### Build failures while installing Python packages
|
||||
|
||||
Make sure the build toolchain is installed:
|
||||
|
||||
```bash
|
||||
pkg install clang rust make pkg-config libffi openssl
|
||||
```
|
||||
|
||||
Then retry:
|
||||
|
||||
```bash
|
||||
python -m pip install -e '.[termux]' -c constraints-termux.txt
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Known limitations on phones
|
||||
|
||||
- Docker backend is unavailable
|
||||
- local voice transcription via `faster-whisper` is unavailable in the tested path
|
||||
- browser automation setup is intentionally skipped by the installer
|
||||
- some optional extras may work, but only `.[termux]` is currently documented as the tested Android bundle
|
||||
|
||||
If you hit a new Android-specific issue, please open a GitHub issue with:
|
||||
- your Android version
|
||||
- `termux-info`
|
||||
- `python --version`
|
||||
- `hermes doctor`
|
||||
- the exact install command and full error output
|
||||
Loading…
Add table
Add a link
Reference in a new issue