mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-18 04:41:56 +00:00
252d68fd45
* docs: deep audit — fix stale config keys, missing commands, and registry drift Cross-checked ~80 high-impact docs pages (getting-started, reference, top-level user-guide, user-guide/features) against the live registries: hermes_cli/commands.py COMMAND_REGISTRY (slash commands) hermes_cli/auth.py PROVIDER_REGISTRY (providers) hermes_cli/config.py DEFAULT_CONFIG (config keys) toolsets.py TOOLSETS (toolsets) tools/registry.py get_all_tool_names() (tools) python -m hermes_cli.main <subcmd> --help (CLI args) reference/ - cli-commands.md: drop duplicate hermes fallback row + duplicate section, add stepfun/lmstudio to --provider enum, expand auth/mcp/curator subcommand lists to match --help output (status/logout/spotify, login, archive/prune/ list-archived). - slash-commands.md: add missing /sessions and /reload-skills entries + correct the cross-platform Notes line. - tools-reference.md: drop bogus '68 tools' headline, drop fictional 'browser-cdp toolset' (these tools live in 'browser' and are runtime-gated), add missing 'kanban' and 'video' toolset sections, fix MCP example to use the real mcp_<server>_<tool> prefix. - toolsets-reference.md: list browser_cdp/browser_dialog inside the 'browser' row, add missing 'kanban' and 'video' toolset rows, drop the stale '38 tools' count for hermes-cli. - profile-commands.md: add missing install/update/info subcommands, document fish completion. - environment-variables.md: dedupe GMI_API_KEY/GMI_BASE_URL rows (kept the one with the correct gmi-serving.com default). - faq.md: Anthropic/Google/OpenAI examples — direct providers exist (not just via OpenRouter), refresh the OpenAI model list. getting-started/ - installation.md: PortableGit (not MinGit) is what the Windows installer fetches; document the 32-bit MinGit fallback. - installation.md / termux.md: installer prefers .[termux-all] then falls back to .[termux]. - nix-setup.md: Python 3.12 (not 3.11), Node.js 22 (not 20); fix invalid 'nix flake update --flake' invocation. - updating.md: 'hermes backup restore --state pre-update' doesn't exist — point at the snapshot/quick-snapshot flow; correct config key 'updates.pre_update_backup' (was 'update.backup'). user-guide/ - configuration.md: api_max_retries default 3 (not 2); display.runtime_footer is the real key (not display.runtime_metadata_footer); checkpoints defaults enabled=false / max_snapshots=20 (not true / 50). - configuring-models.md: 'hermes model list' / 'hermes model set ...' don't exist — hermes model is interactive only. - tui.md: busy_indicator -> tui_status_indicator with values kaomoji|emoji|unicode|ascii (not kawaii|minimal|dots|wings|none). - security.md: SSH backend keys (TERMINAL_SSH_HOST/USER/KEY) live in .env, not config.yaml. - windows-wsl-quickstart.md: there is no 'hermes api' subcommand — the OpenAI-compatible API server runs inside hermes gateway. user-guide/features/ - computer-use.md: approvals.mode (not security.approval_level); fix broken ./browser-use.md link to ./browser.md. - fallback-providers.md: top-level fallback_providers (not model.fallback_providers); the picker is subcommand-based, not modal. - api-server.md: API_SERVER_* are env vars — write to per-profile .env, not 'hermes config set' which targets YAML. - web-search.md: drop web_crawl as a registered tool (it isn't); deep-crawl modes are exposed through web_extract. - kanban.md: failure_limit default is 2, not '~5'. - plugins.md: drop hard-coded '33 providers' count. - honcho.md: fix unclosed quote in echo HONCHO_API_KEY snippet; document that 'hermes honcho' subcommand is gated on memory.provider=honcho; reconcile subcommand list with actual --help output. - memory-providers.md: legacy 'hermes honcho setup' redirect documented. Verified via 'npm run build' — site builds cleanly; broken-link count went from 149 to 146 (no regressions, fixed a few in passing). * docs: round 2 audit fixes + regenerate skill catalogs Follow-up to the previous commit on this branch: Round 2 manual fixes: - quickstart.md: KIMI_CODING_API_KEY mentioned alongside KIMI_API_KEY; voice-mode and ACP install commands rewritten — bare 'pip install ...' doesn't work for curl-installed setups (no pip on PATH, not in repo dir); replaced with 'cd ~/.hermes/hermes-agent && uv pip install -e ".[voice]"'. ACP already ships in [all] so the curl install includes it. - cli.md / configuration.md: 'auxiliary.compression.model' shown as 'google/gemini-3-flash-preview' (the doc's own claimed default); actual default is empty (= use main model). Reworded as 'leave empty (default) or pin a cheap model'. - built-in-plugins.md: added the bundled 'kanban/dashboard' plugin row that was missing from the table. Regenerated skill catalogs: - ran website/scripts/generate-skill-docs.py to refresh all 163 per-skill pages and both reference catalogs (skills-catalog.md, optional-skills-catalog.md). This adds the entries that were genuinely missing — productivity/teams-meeting-pipeline (bundled), optional/finance/* (entire category — 7 skills: 3-statement-model, comps-analysis, dcf-model, excel-author, lbo-model, merger-model, pptx-author), creative/hyperframes, creative/kanban-video-orchestrator, devops/watchers, productivity/shop-app, research/searxng-search, apple/macos-computer-use — and rewrites every other per-skill page from the current SKILL.md. Most diffs are tiny (one line of refreshed metadata). Validation: - 'npm run build' succeeded. - Broken-link count moved 146 -> 155 — the +9 are zh-Hans translation shells that lag every newly-added skill page (pre-existing pattern). No regressions on any en/ page.
215 lines
7.3 KiB
Markdown
215 lines
7.3 KiB
Markdown
---
|
||
sidebar_position: 3
|
||
title: "Updating & Uninstalling"
|
||
description: "How to update Hermes Agent to the latest version or uninstall it"
|
||
---
|
||
|
||
# Updating & Uninstalling
|
||
|
||
## Updating
|
||
|
||
Update to the latest version with a single command:
|
||
|
||
```bash
|
||
hermes update
|
||
```
|
||
|
||
This pulls the latest code, updates dependencies, and prompts you to configure any new options that were added since your last update.
|
||
|
||
:::tip
|
||
`hermes update` automatically detects new configuration options and prompts you to add them. If you skipped that prompt, you can manually run `hermes config check` to see missing options, then `hermes config migrate` to interactively add them.
|
||
:::
|
||
|
||
### What happens during an update
|
||
|
||
When you run `hermes update`, the following steps occur:
|
||
|
||
1. **Pairing-data snapshot** — a lightweight pre-update state snapshot is saved (covers `~/.hermes/pairing/`, Feishu comment rules, and other state files that get modified at runtime). Recoverable via the snapshot restore flow described under [Snapshots and rollback](../user-guide/checkpoints-and-rollback.md), or by extracting the most recent quick-snapshot zip Hermes wrote next to your `~/.hermes/` directory.
|
||
2. **Git pull** — pulls the latest code from the `main` branch and updates submodules
|
||
3. **Dependency install** — runs `uv pip install -e ".[all]"` to pick up new or changed dependencies
|
||
4. **Config migration** — detects new config options added since your version and prompts you to set them
|
||
5. **Gateway auto-restart** — running gateways are refreshed after the update completes so the new code takes effect immediately. Service-managed gateways (systemd on Linux, launchd on macOS) are restarted through the service manager. Manual gateways are relaunched automatically when Hermes can map the running PID back to a profile.
|
||
|
||
### Preview-only: `hermes update --check`
|
||
|
||
Want to know if you're behind `origin/main` before actually pulling? Run `hermes update --check` — it fetches, prints your local commit and the latest remote commit side-by-side, and exits `0` if in sync or `1` if behind. No files are modified, no gateway is restarted. Useful in scripts and cron jobs that gate on "is there an update".
|
||
|
||
### Full pre-update backup: `--backup`
|
||
|
||
For high-value profiles (production gateways, shared team installs) you can opt into a full pre-pull backup of `HERMES_HOME` (config, auth, sessions, skills, pairing):
|
||
|
||
```bash
|
||
hermes update --backup
|
||
```
|
||
|
||
Or make it the default for every run:
|
||
|
||
```yaml
|
||
# ~/.hermes/config.yaml
|
||
updates:
|
||
pre_update_backup: true
|
||
```
|
||
|
||
`--backup` was the always-on behavior in earlier builds, but it was adding minutes to every update on large homes, so it's now opt-in. The lightweight pairing-data snapshot above still runs unconditionally.
|
||
|
||
Expected output looks like:
|
||
|
||
```
|
||
$ hermes update
|
||
Updating Hermes Agent...
|
||
📥 Pulling latest code...
|
||
Already up to date. (or: Updating abc1234..def5678)
|
||
📦 Updating dependencies...
|
||
✅ Dependencies updated
|
||
🔍 Checking for new config options...
|
||
✅ Config is up to date (or: Found 2 new options — running migration...)
|
||
🔄 Restarting gateways...
|
||
✅ Gateway restarted
|
||
✅ Hermes Agent updated successfully!
|
||
```
|
||
|
||
### Recommended Post-Update Validation
|
||
|
||
`hermes update` handles the main update path, but a quick validation confirms everything landed cleanly:
|
||
|
||
1. `git status --short` — if the tree is unexpectedly dirty, inspect before continuing
|
||
2. `hermes doctor` — checks config, dependencies, and service health
|
||
3. `hermes --version` — confirm the version bumped as expected
|
||
4. If you use the gateway: `hermes gateway status`
|
||
5. If `doctor` reports npm audit issues: run `npm audit fix` in the flagged directory
|
||
|
||
:::warning Dirty working tree after update
|
||
If `git status --short` shows unexpected changes after `hermes update`, stop and inspect them before continuing. This usually means local modifications were reapplied on top of the updated code, or a dependency step refreshed lockfiles.
|
||
:::
|
||
|
||
### If your terminal disconnects mid-update
|
||
|
||
`hermes update` protects itself against accidental terminal loss:
|
||
|
||
- The update ignores `SIGHUP`, so closing your SSH session or terminal window no longer kills it mid-install. `pip` and `git` child processes inherit this protection, so the Python environment cannot be left half-installed by a dropped connection.
|
||
- All output is mirrored to `~/.hermes/logs/update.log` while the update runs. If your terminal disappears, reconnect and inspect the log to see whether the update finished and whether the gateway restart succeeded:
|
||
|
||
```bash
|
||
tail -f ~/.hermes/logs/update.log
|
||
```
|
||
|
||
- `Ctrl-C` (SIGINT) and system shutdown (SIGTERM) are still honored — those are deliberate cancellations, not accidents.
|
||
|
||
You no longer need to wrap `hermes update` in `screen` or `tmux` to survive a terminal drop.
|
||
|
||
### Checking your current version
|
||
|
||
```bash
|
||
hermes version
|
||
```
|
||
|
||
Compare against the latest release at the [GitHub releases page](https://github.com/NousResearch/hermes-agent/releases).
|
||
|
||
### Updating from Messaging Platforms
|
||
|
||
You can also update directly from Telegram, Discord, Slack, WhatsApp, or Teams by sending:
|
||
|
||
```
|
||
/update
|
||
```
|
||
|
||
This pulls the latest code, updates dependencies, and restarts running gateways. The bot will briefly go offline during the restart (typically 5–15 seconds) and then resume.
|
||
|
||
### Manual Update
|
||
|
||
If you installed manually (not via the quick installer):
|
||
|
||
```bash
|
||
cd /path/to/hermes-agent
|
||
export VIRTUAL_ENV="$(pwd)/venv"
|
||
|
||
# Pull latest code and submodules
|
||
git pull origin main
|
||
git submodule update --init --recursive
|
||
|
||
# Reinstall (picks up new dependencies)
|
||
uv pip install -e ".[all]"
|
||
uv pip install -e "./tinker-atropos"
|
||
|
||
# Check for new config options
|
||
hermes config check
|
||
hermes config migrate # Interactively add any missing options
|
||
```
|
||
|
||
### Rollback instructions
|
||
|
||
If an update introduces a problem, you can roll back to a previous version:
|
||
|
||
```bash
|
||
cd /path/to/hermes-agent
|
||
|
||
# List recent versions
|
||
git log --oneline -10
|
||
|
||
# Roll back to a specific commit
|
||
git checkout <commit-hash>
|
||
git submodule update --init --recursive
|
||
uv pip install -e ".[all]"
|
||
|
||
# Restart the gateway if running
|
||
hermes gateway restart
|
||
```
|
||
|
||
To roll back to a specific release tag:
|
||
|
||
```bash
|
||
git checkout v0.6.0
|
||
git submodule update --init --recursive
|
||
uv pip install -e ".[all]"
|
||
```
|
||
|
||
:::warning
|
||
Rolling back may cause config incompatibilities if new options were added. Run `hermes config check` after rolling back and remove any unrecognized options from `config.yaml` if you encounter errors.
|
||
:::
|
||
|
||
### Note for Nix users
|
||
|
||
If you installed via Nix flake, updates are managed through the Nix package manager:
|
||
|
||
```bash
|
||
# Update the flake input
|
||
nix flake update hermes-agent
|
||
|
||
# Or rebuild with the latest
|
||
nix profile upgrade hermes-agent
|
||
```
|
||
|
||
Nix installations are immutable — rollback is handled by Nix's generation system:
|
||
|
||
```bash
|
||
nix profile rollback
|
||
```
|
||
|
||
See [Nix Setup](./nix-setup.md) for more details.
|
||
|
||
---
|
||
|
||
## Uninstalling
|
||
|
||
```bash
|
||
hermes uninstall
|
||
```
|
||
|
||
The uninstaller gives you the option to keep your configuration files (`~/.hermes/`) for a future reinstall.
|
||
|
||
### Manual Uninstall
|
||
|
||
```bash
|
||
rm -f ~/.local/bin/hermes
|
||
rm -rf /path/to/hermes-agent
|
||
rm -rf ~/.hermes # Optional — keep if you plan to reinstall
|
||
```
|
||
|
||
:::info
|
||
If you installed the gateway as a system service, stop and disable it first:
|
||
```bash
|
||
hermes gateway stop
|
||
# Linux: systemctl --user disable hermes-gateway
|
||
# macOS: launchctl remove ai.hermes.gateway
|
||
```
|
||
:::
|