mirrors/hermes-agent
1
0
Fork 0
mirror of https://github.com/NousResearch/hermes-agent.git synced 2026-05-22 05:22:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

docs: add pip install path to installation, quickstart, updating, and CLI reference

Browse source 
Document pip install hermes-agent as a first-class install option.
Clarify that PyPI releases track tagged versions (major/minor),
not every commit on main — git installer is for bleeding-edge.
This commit is contained in:
alt-glitch 2026-05-15 13:45:46 +00:00 • committed by Teknium
parent 99b81cd54b
commit 164a77dec9
4 changed files with 69 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

32
website/docs/getting-started/installation.md
View file

@ -10,7 +10,30 @@ Get Hermes Agent up and running in under two minutes with the one-line installer
## Quick Install
### Linux / macOS / WSL2
### pip (recommended for most users)
```bash
pip install hermes-agent
```
This gives you the full Hermes Agent — CLI, web dashboard, and TUI — with zero external dependencies for core usage. Node.js, browser engines, and other optional tools are bootstrapped lazily on first use (e.g. when you run `hermes --tui` or use browser tools).
PyPI releases track **tagged versions** (major and minor releases), not every commit on `main`. If you want bleeding-edge changes as they land, use the git install below.
After installing, run:
```bash
hermes setup # interactive wizard — configures your LLM provider and API key
hermes # start chatting
```
:::tip
If you have [uv](https://docs.astral.sh/uv/) installed, `uv pip install hermes-agent` is faster.
:::
### One-Line Installer (Linux / macOS / WSL2)
For a git-based install that tracks `main` and gives you the latest changes immediately:
```bash
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
@ -80,7 +103,8 @@ Where the installer puts things depends on whether you're installing as a normal
| Installer | Code lives at | `hermes` binary | Data directory |
|---|---|---|---|
| Per-user (normal) | `~/.hermes/hermes-agent/` | `~/.local/bin/hermes` (symlink) | `~/.hermes/` |
| pip install | Python site-packages | `~/.local/bin/hermes` (console_scripts) | `~/.hermes/` |
| Per-user (git installer) | `~/.hermes/hermes-agent/` | `~/.local/bin/hermes` (symlink) | `~/.hermes/` |
| Root-mode (`sudo curl … \| sudo bash`) | `/usr/local/lib/hermes-agent/` | `/usr/local/bin/hermes` | `/root/.hermes/` (or `$HERMES_HOME`) |
The root-mode **FHS layout** (`/usr/local/lib/…`, `/usr/local/bin/hermes`) matches where other system-wide developer tools land on Linux. It's useful for shared-machine deployments where one system install should serve every user. Per-user config (auth, skills, sessions) still lives under each user's `~/.hermes/` or explicit `HERMES_HOME`.
@ -108,7 +132,9 @@ hermes setup # Or run the full setup wizard to configure everything at
## Prerequisites
The only prerequisite is **Git**. The installer automatically handles everything else:
**pip install:** No prerequisites beyond Python 3.11+. Everything else is handled automatically.
**Git installer:** The only prerequisite is **Git**. The installer automatically handles everything else:
- **uv** (fast Python package manager)
- **Python 3.11** (via uv, no sudo needed)