From a911bcda18cf83273d0aabd3e67adb2206436e60 Mon Sep 17 00:00:00 2001 From: Teknium <127238744+teknium1@users.noreply.github.com> Date: Wed, 24 Jun 2026 00:14:32 -0700 Subject: [PATCH] docs: stop recommending pip install; curl installer is the only supported path (#51743) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: stop recommending pip install hermes-agent; point to install script The install script is the only supported install path (it provisions a managed, isolated uv environment). Replace bare `pip install hermes-agent` primary-install recommendations with the curl install script, and rewrite optional-extra snippets (`pip install "hermes-agent[X]"`) to the managed-env form `cd ~/.hermes/hermes-agent && uv pip install -e ".[X]"` that matches the installer and the English quickstart. Covers English docs + zh-Hans mirrors, the achievements plugin README, and realigns the zh-Hans quickstart to the English Desktop-installer-first layout (dropping its stale "Method A — pip (simplest)" section). * docs: drop pip as a supported install/update method Removes the 'pip installs' supported-method sections from updating.md and cli-commands.md (EN + zh-Hans): the curl install script is the only supported way to install/update the Hermes CLI. The _cmd_update_pip pip/pipx branches remain in code as an undocumented safety net for users who already have such an install, but the docs no longer advertise pip as a path. Also normalizes a bare `pip install -e '.[acp]'` to the managed-env form. Leaves python-library.md untouched: importing AIAgent as a library dependency into your own project is a distinct use case where pip is correct. --- hermes-already-has-routines.md | 2 +- plugins/hermes-achievements/README.md | 2 +- website/docs/getting-started/updating.md | 30 ++----------------- website/docs/guides/aws-bedrock.md | 4 +-- .../docs/guides/use-voice-mode-with-hermes.md | 8 ++--- website/docs/reference/cli-commands.md | 14 ++++----- website/docs/reference/faq.md | 2 +- website/docs/user-guide/features/tts.md | 2 +- .../docs/user-guide/features/voice-mode.md | 10 +++---- .../docs/user-guide/features/web-dashboard.md | 6 ++-- website/docs/user-guide/messaging/dingtalk.md | 2 +- website/docs/user-guide/messaging/matrix.md | 6 ++-- website/docs/user-guide/messaging/sms.md | 2 +- website/docs/user-guide/messaging/weixin.md | 4 +-- .../current/getting-started/quickstart.md | 13 ++++---- .../current/getting-started/updating.md | 30 ++----------------- .../current/guides/aws-bedrock.md | 4 +-- .../guides/use-voice-mode-with-hermes.md | 8 ++--- .../current/reference/cli-commands.md | 10 +++---- .../current/reference/faq.md | 2 +- .../current/user-guide/features/tts.md | 2 +- .../current/user-guide/features/voice-mode.md | 10 +++---- .../user-guide/features/web-dashboard.md | 6 ++-- .../current/user-guide/messaging/dingtalk.md | 2 +- .../current/user-guide/messaging/matrix.md | 6 ++-- .../current/user-guide/messaging/sms.md | 2 +- .../current/user-guide/messaging/weixin.md | 4 +-- 27 files changed, 68 insertions(+), 125 deletions(-) diff --git a/hermes-already-has-routines.md b/hermes-already-has-routines.md index e33ebfab5ad..653fc9d46fc 100644 --- a/hermes-already-has-routines.md +++ b/hermes-already-has-routines.md @@ -127,7 +127,7 @@ A nightly backlog triage on Sonnet costs roughly $0.02-0.05. A monitoring check Hermes Agent is open source and free. The automation infrastructure — cron scheduler, webhook platform, skill system, multi-platform delivery — is built in. ```bash -pip install hermes-agent +curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash hermes setup ``` diff --git a/plugins/hermes-achievements/README.md b/plugins/hermes-achievements/README.md index 01325f3f74e..b2deb52d397 100644 --- a/plugins/hermes-achievements/README.md +++ b/plugins/hermes-achievements/README.md @@ -2,7 +2,7 @@ > **Bundled with Hermes Agent.** Originally authored by [@PCinkusz](https://github.com/PCinkusz) at https://github.com/PCinkusz/hermes-achievements — vendored into `plugins/hermes-achievements/` so it ships with the dashboard out-of-the-box and stays in lockstep with Hermes feature changes. Upstream repo remains the staging ground for new badges and UI iteration. > -> When Hermes is installed via `pip install hermes-agent` or cloned from source, this plugin auto-registers as a dashboard tab on first `hermes dashboard` launch. No separate install step. See [Built-in Plugins → hermes-achievements](../../website/docs/user-guide/features/built-in-plugins.md) in the main docs. +> When Hermes is installed via the install script or cloned from source, this plugin auto-registers as a dashboard tab on first `hermes dashboard` launch. No separate install step. See [Built-in Plugins → hermes-achievements](../../website/docs/user-guide/features/built-in-plugins.md) in the main docs. Achievement system for the Hermes Dashboard: collectible, tiered badges generated from real local Hermes session history. diff --git a/website/docs/getting-started/updating.md b/website/docs/getting-started/updating.md index 330b730075d..ae1ba843708 100644 --- a/website/docs/getting-started/updating.md +++ b/website/docs/getting-started/updating.md @@ -8,8 +8,6 @@ description: "How to update Hermes Agent to the latest version or uninstall it" ## Updating -### Git installs - Update to the latest version with a single command: ```bash @@ -18,26 +16,11 @@ hermes update This pulls the latest code from `main`, updates dependencies, and prompts you to configure any new options that were added since your last update. -### pip installs - -PyPI releases track **tagged versions** (major and minor releases), not every commit on `main`. Check for updates and upgrade with: - -```bash -hermes update --check # see if a newer release is on PyPI -hermes update # runs pip install --upgrade hermes-agent -``` - -Or manually: - -```bash -pip install --upgrade hermes-agent # or: uv pip install --upgrade hermes-agent -``` - :::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 (git installs) +### What happens during an update When you run `hermes update`, the following steps occur: @@ -79,7 +62,7 @@ In the desktop app this is **Settings → Advanced → In-App Update Local Chang ### Preview-only: `hermes update --check` -Want to know if an update is available before pulling? Run `hermes update --check` — for git installs it fetches and compares commits against `origin/main`; for pip installs it queries PyPI for the latest release. No files are modified, no gateway is restarted. Useful in scripts and cron jobs that gate on "is there an update". +Want to know if an update is available before pulling? Run `hermes update --check` — it fetches and compares commits against `origin/main`. 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` @@ -254,21 +237,12 @@ See [Nix Setup](./nix-setup.md) for more details. ## Uninstalling -### Git installs - ```bash hermes uninstall ``` The uninstaller gives you the option to keep your configuration files (`~/.hermes/`) for a future reinstall. -### pip installs - -```bash -pip uninstall hermes-agent -rm -rf ~/.hermes # Optional — keep if you plan to reinstall -``` - ### Manual Uninstall ```bash diff --git a/website/docs/guides/aws-bedrock.md b/website/docs/guides/aws-bedrock.md index 3e09822c1a8..4c8389ae5e2 100644 --- a/website/docs/guides/aws-bedrock.md +++ b/website/docs/guides/aws-bedrock.md @@ -15,7 +15,7 @@ Hermes Agent supports Amazon Bedrock as a native provider using the **Converse A - `AWS_ACCESS_KEY_ID` + `AWS_SECRET_ACCESS_KEY` environment variables - `AWS_PROFILE` for SSO or named profiles - `aws configure` for local development -- **boto3** — install with `pip install hermes-agent[bedrock]` +- **boto3** — install with `cd ~/.hermes/hermes-agent && uv pip install -e ".[bedrock]"` - **IAM permissions** — at minimum: - `bedrock:InvokeModel` and `bedrock:InvokeModelWithResponseStream` (for inference) - `bedrock:ListFoundationModels` and `bedrock:ListInferenceProfiles` (for model discovery) @@ -28,7 +28,7 @@ On AWS compute, attach an IAM role with `AmazonBedrockFullAccess` and you're don ```bash # Install with Bedrock support -pip install hermes-agent[bedrock] +cd ~/.hermes/hermes-agent && uv pip install -e ".[bedrock]" # Select Bedrock as your provider hermes model diff --git a/website/docs/guides/use-voice-mode-with-hermes.md b/website/docs/guides/use-voice-mode-with-hermes.md index 90ca25bdb94..b99b19211a6 100644 --- a/website/docs/guides/use-voice-mode-with-hermes.md +++ b/website/docs/guides/use-voice-mode-with-hermes.md @@ -61,19 +61,19 @@ If that is not solid yet, fix text mode first. ### CLI microphone + playback ```bash -pip install "hermes-agent[voice]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[voice]" ``` ### Messaging platforms ```bash -pip install "hermes-agent[messaging]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]" ``` ### Premium ElevenLabs TTS ```bash -pip install "hermes-agent[tts-premium]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[tts-premium]" ``` ### Local NeuTTS (optional) @@ -85,7 +85,7 @@ python -m pip install -U neutts[all] ### Everything ```bash -pip install "hermes-agent[all]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[all]" ``` ## Step 3: install system dependencies diff --git a/website/docs/reference/cli-commands.md b/website/docs/reference/cli-commands.md index 5511f3c8e9a..5707840edee 100644 --- a/website/docs/reference/cli-commands.md +++ b/website/docs/reference/cli-commands.md @@ -84,7 +84,7 @@ hermes [global-options] [subcommand/options] | `hermes profile` | Manage profiles — multiple isolated Hermes instances. | | `hermes completion` | Print shell completion scripts (bash/zsh/fish). | | `hermes version` | Show version information. | -| `hermes update` | Pull latest code and reinstall dependencies (git installs), or check PyPI and `pip install --upgrade` (pip installs). `--check` previews without installing; `--backup` takes a pre-pull `HERMES_HOME` snapshot. | +| `hermes update` | Pull latest code and reinstall dependencies. `--check` previews without installing; `--backup` takes a pre-pull `HERMES_HOME` snapshot. | | `hermes uninstall` | Remove Hermes from the system. | ## `hermes chat` @@ -1191,7 +1191,7 @@ python -m acp_adapter Install support first: ```bash -pip install -e '.[acp]' +cd ~/.hermes/hermes-agent && uv pip install -e '.[acp]' ``` See [ACP Editor Integration](../user-guide/features/acp.md) and [ACP Internals](../developer-guide/acp-internals.md). @@ -1372,7 +1372,7 @@ hermes claw migrate --source /home/user/old-openclaw hermes dashboard [options] ``` -Launch the web dashboard — a browser-based UI for managing configuration, API keys, and monitoring sessions. Requires `pip install hermes-agent[web]` (FastAPI + Uvicorn). The embedded browser Chat tab is always available and additionally needs the `pty` extra (`pip install 'hermes-agent[web,pty]'`) plus a POSIX PTY environment such as Linux, macOS, or WSL2. See [Web Dashboard](/user-guide/features/web-dashboard) for full documentation. +Launch the web dashboard — a browser-based UI for managing configuration, API keys, and monitoring sessions. Requires `cd ~/.hermes/hermes-agent && uv pip install -e ".[web]"` (FastAPI + Uvicorn). The embedded browser Chat tab is always available and additionally needs the `pty` extra (`cd ~/.hermes/hermes-agent && uv pip install -e ".[web,pty]"`) plus a POSIX PTY environment such as Linux, macOS, or WSL2. See [Web Dashboard](/user-guide/features/web-dashboard) for full documentation. | Option | Default | Description | |--------|---------|-------------| @@ -1460,11 +1460,9 @@ hermes completion fish > ~/.config/fish/completions/hermes.fish hermes update [--gateway] [--check] [--no-backup] [--backup] [--yes] ``` -Pulls the latest `hermes-agent` code and reinstalls dependencies in your venv, then re-runs the post-install hooks (MCP servers, skills sync, completion install). Safe to run on a live install. +Pulls the latest `hermes-agent` code and reinstalls dependencies in the managed venv, then re-runs the post-install hooks (MCP servers, skills sync, completion install). Safe to run on a live install. Use `--check` to see whether your checkout is behind `origin/main` without installing. -**pip installs:** `hermes update` detects pip-based installations automatically — it queries PyPI for the latest release and runs `pip install --upgrade hermes-agent` instead of `git pull`. PyPI releases track tagged versions (major/minor releases), not every commit on `main`. Use `--check` to see if a newer PyPI release is available without installing. - -**git installs:** `hermes update` pulls the configured update branch (default: `main`). If your checkout is on another branch, Hermes may check out the update branch before pulling. Commit branch work before updating when you want to keep it outside the update autostash flow. +`hermes update` pulls the configured update branch (default: `main`). If your checkout is on another branch, Hermes may check out the update branch before pulling. Commit branch work before updating when you want to keep it outside the update autostash flow. | Option | Description | |--------|-------------| @@ -1489,7 +1487,7 @@ Additional behavior: |---------|-------------| | `hermes version` | Print version information. | | `hermes update` | Pull latest changes and reinstall dependencies. | -| `hermes postinstall` | Internal bootstrap. Runs once after `pip install hermes-agent` (or `hermes update` on pip installs) to install non-Python dependencies that pip cannot provide — Node.js runtime, headless browser, ripgrep, ffmpeg — and then trigger `hermes setup` if the profile has not been configured yet. Safe to re-run idempotently. | +| `hermes postinstall` | Internal bootstrap. Runs once after the install script provisions Hermes (or after `hermes update`) to install non-Python dependencies that pip cannot provide — Node.js runtime, headless browser, ripgrep, ffmpeg — and then trigger `hermes setup` if the profile has not been configured yet. Safe to re-run idempotently. | | `hermes uninstall [--full] [--gui] [--yes]` | Remove Hermes, optionally deleting all config/data. `--gui` removes only the desktop Chat GUI, leaving the agent intact; `--full` also deletes config/data; `--yes` skips prompts. | ## See also diff --git a/website/docs/reference/faq.md b/website/docs/reference/faq.md index 761b8920063..5c4531719cd 100644 --- a/website/docs/reference/faq.md +++ b/website/docs/reference/faq.md @@ -445,7 +445,7 @@ Configure in `~/.hermes/config.yaml` under your gateway's settings. See the [Mes **Solution:** ```bash # Install core messaging gateway dependencies -pip install "hermes-agent[messaging]" # Telegram, Discord, Slack, and shared gateway deps +cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]" # Telegram, Discord, Slack, and shared gateway deps # Check for port conflicts lsof -i :8080 diff --git a/website/docs/user-guide/features/tts.md b/website/docs/user-guide/features/tts.md index 9912d834972..d62ad4a0c46 100644 --- a/website/docs/user-guide/features/tts.md +++ b/website/docs/user-guide/features/tts.md @@ -453,7 +453,7 @@ stt: **OpenAI API** — Accepts `VOICE_TOOLS_OPENAI_KEY` first and falls back to `OPENAI_API_KEY`. Supports `whisper-1`, `gpt-4o-mini-transcribe`, and `gpt-4o-transcribe`. -**Mistral API (Voxtral Transcribe)** — Requires `MISTRAL_API_KEY`. Uses Mistral's [Voxtral Transcribe](https://docs.mistral.ai/capabilities/audio/speech_to_text/) models. Supports 13 languages, speaker diarization, and word-level timestamps. Install with `pip install hermes-agent[mistral]`. +**Mistral API (Voxtral Transcribe)** — Requires `MISTRAL_API_KEY`. Uses Mistral's [Voxtral Transcribe](https://docs.mistral.ai/capabilities/audio/speech_to_text/) models. Supports 13 languages, speaker diarization, and word-level timestamps. Install with `cd ~/.hermes/hermes-agent && uv pip install -e ".[mistral]"`. **xAI Grok STT** — Requires `XAI_API_KEY`. Posts to `https://api.x.ai/v1/stt` as multipart/form-data. Good choice if you're already using xAI for chat or TTS and want one API key for everything. Auto-detection order puts it after Groq — explicitly set `stt.provider: xai` to force it. diff --git a/website/docs/user-guide/features/voice-mode.md b/website/docs/user-guide/features/voice-mode.md index ab0b0a62fed..f32d96d151c 100644 --- a/website/docs/user-guide/features/voice-mode.md +++ b/website/docs/user-guide/features/voice-mode.md @@ -14,7 +14,7 @@ If you want a practical setup walkthrough with recommended configurations and re Before using voice features, make sure you have: -1. **Hermes Agent installed** — `pip install hermes-agent` (see [Installation](/getting-started/installation)) +1. **Hermes Agent installed** — via the install script (see [Installation](/getting-started/installation)) 2. **An LLM provider configured** — run `hermes model` or set your preferred provider credentials in `~/.hermes/.env` 3. **A working base setup** — run `hermes` to verify the agent responds to text before enabling voice @@ -40,19 +40,19 @@ A paid [Nous Portal](/user-guide/features/tool-gateway) subscription supplies th ```bash # CLI voice mode (microphone + audio playback) -pip install "hermes-agent[voice]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[voice]" # Discord + Telegram messaging (includes discord.py[voice] for VC support) -pip install "hermes-agent[messaging]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]" # Premium TTS (ElevenLabs) -pip install "hermes-agent[tts-premium]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[tts-premium]" # Local TTS (NeuTTS, optional) python -m pip install -U neutts[all] # Everything at once -pip install "hermes-agent[all]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[all]" ``` | Extra | Packages | Required For | diff --git a/website/docs/user-guide/features/web-dashboard.md b/website/docs/user-guide/features/web-dashboard.md index 64db237cae4..90b210f04ee 100644 --- a/website/docs/user-guide/features/web-dashboard.md +++ b/website/docs/user-guide/features/web-dashboard.md @@ -83,10 +83,10 @@ across profiles with its own filter). The default `hermes-agent` install does not ship the HTTP stack or PTY helper — those are optional extras. The **web dashboard** needs FastAPI and Uvicorn (`web` extra). The **Chat** tab also needs `ptyprocess` to spawn the embedded TUI behind a pseudo-terminal (`pty` extra on POSIX). Install both with: ```bash -pip install 'hermes-agent[web,pty]' +cd ~/.hermes/hermes-agent && uv pip install -e ".[web,pty]" ``` -The `web` extra pulls in FastAPI/Uvicorn; `pty` pulls in `ptyprocess` (POSIX) or `pywinpty` (native Windows — note that the embedded TUI itself still requires WSL). `pip install hermes-agent[all]` includes both extras and is the easiest path if you also want messaging/voice/etc. +The `web` extra pulls in FastAPI/Uvicorn; `pty` pulls in `ptyprocess` (POSIX) or `pywinpty` (native Windows — note that the embedded TUI itself still requires WSL). `cd ~/.hermes/hermes-agent && uv pip install -e ".[all]"` includes both extras and is the easiest path if you also want messaging/voice/etc. When you run `hermes dashboard` without the dependencies, it will tell you what to install. If the frontend hasn't been built yet and `npm` is available, it builds automatically on first launch. @@ -124,7 +124,7 @@ The **Chat** tab embeds the full Hermes TUI (the same interface you get from `he **Prerequisites:** - Node.js (same requirement as `hermes --tui`; the TUI bundle is built on first launch) -- `ptyprocess` — installed by the `pty` extra (`pip install 'hermes-agent[web,pty]'`, or `[all]` covers both) +- `ptyprocess` — installed by the `pty` extra (`cd ~/.hermes/hermes-agent && uv pip install -e ".[web,pty]"`, or `[all]` covers both) - POSIX kernel (Linux, macOS, or WSL2). The `/chat` terminal pane specifically needs a POSIX PTY — native Windows Python has no equivalent, so on a native Windows install the rest of the dashboard (sessions, jobs, metrics, config editor) works but the `/chat` tab will show a banner telling you to use WSL2 for that feature. Close the browser tab and the PTY is reaped cleanly on the server. Re-opening spawns a fresh session. diff --git a/website/docs/user-guide/messaging/dingtalk.md b/website/docs/user-guide/messaging/dingtalk.md index 21dd45b539c..ce0d16a4f51 100644 --- a/website/docs/user-guide/messaging/dingtalk.md +++ b/website/docs/user-guide/messaging/dingtalk.md @@ -44,7 +44,7 @@ This guide walks you through the full setup process — from creating your DingT Install the required Python packages: ```bash -pip install "hermes-agent[dingtalk]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[dingtalk]" ``` Or individually: diff --git a/website/docs/user-guide/messaging/matrix.md b/website/docs/user-guide/messaging/matrix.md index f69de76a876..75babf5cbab 100644 --- a/website/docs/user-guide/messaging/matrix.md +++ b/website/docs/user-guide/messaging/matrix.md @@ -362,7 +362,7 @@ E2EE requires the `mautrix` library with encryption extras and the `libolm` C li pip install 'mautrix[encryption]' # Or install with hermes extras -pip install 'hermes-agent[matrix]' +cd ~/.hermes/hermes-agent && uv pip install -e ".[matrix]" ``` You also need `libolm` installed on your system: @@ -644,7 +644,7 @@ pip install 'mautrix[encryption]' Or with Hermes extras: ```bash -pip install 'hermes-agent[matrix]' +cd ~/.hermes/hermes-agent && uv pip install -e ".[matrix]" ``` ### Encryption errors / "could not decrypt event" @@ -824,7 +824,7 @@ services: FROM python:3.11-slim RUN apt-get update && apt-get install -y libolm-dev && rm -rf /var/lib/apt/lists/* -RUN pip install 'hermes-agent[matrix]' +RUN cd ~/.hermes/hermes-agent && uv pip install -e ".[matrix]" CMD ["hermes", "gateway"] ``` diff --git a/website/docs/user-guide/messaging/sms.md b/website/docs/user-guide/messaging/sms.md index a6bbf018cb1..8878cc5f0ab 100644 --- a/website/docs/user-guide/messaging/sms.md +++ b/website/docs/user-guide/messaging/sms.md @@ -20,7 +20,7 @@ The SMS gateway shares credentials with the optional [telephony skill](/referenc - **Twilio account** — [Sign up at twilio.com](https://www.twilio.com/try-twilio) (free trial available) - **A Twilio phone number** with SMS capability - **A publicly accessible server** — Twilio sends webhooks to your server when SMS arrives -- **aiohttp** — `pip install 'hermes-agent[sms]'` +- **aiohttp** — `cd ~/.hermes/hermes-agent && uv pip install -e ".[sms]"` --- diff --git a/website/docs/user-guide/messaging/weixin.md b/website/docs/user-guide/messaging/weixin.md index 30d75dd5bcd..b38ee4a472d 100644 --- a/website/docs/user-guide/messaging/weixin.md +++ b/website/docs/user-guide/messaging/weixin.md @@ -34,7 +34,7 @@ Install the required dependencies: ```bash pip install aiohttp cryptography # Optional: for terminal QR code display -pip install hermes-agent[messaging] +cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]" ``` ## Setup @@ -330,4 +330,4 @@ Only one Weixin gateway instance can use a given token at a time. The adapter ac | Voice messages show as text | If WeChat provides a transcription, the adapter uses the text. This is expected behavior | | Messages appear duplicated | The adapter deduplicates by message ID. If you see duplicates, check if multiple gateway instances are running | | `iLink POST ... HTTP 4xx/5xx` | API error from the iLink service. Check your token validity and network connectivity | -| Terminal QR code doesn't render | Reinstall with the messaging extra: `pip install hermes-agent[messaging]`. Alternatively, open the URL printed above the QR | +| Terminal QR code doesn't render | Reinstall with the messaging extra: `cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]"`. Alternatively, open the URL printed above the QR | diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/quickstart.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/quickstart.md index 7651bc95d27..c77e83dfef2 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/quickstart.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/quickstart.md @@ -48,22 +48,21 @@ description: "与 Hermes Agent 的第一次对话——从安装到开始聊天 ## 1. 安装 Hermes Agent -**方式 A — pip(最简单):** +### 在 macOS 或 Windows 上使用 Hermes Desktop 安装器(推荐) -```bash -pip install hermes-agent -hermes postinstall # 可选:安装 Node.js、浏览器、ripgrep、ffmpeg 并运行 setup -``` +如需同时安装命令行与桌面应用,请从我们的官网[下载 Hermes Desktop 安装器](https://hermes-agent.nousresearch.com/)并运行。 -PyPI 发布版本跟踪带标签的版本(主/次版本发布),而非 `main` 分支上的每次提交。如需最新代码,请使用方式 B。 +### 不使用 Hermes Desktop: -**方式 B — git 安装器(跟踪 main 分支):** +仅安装命令行版本(跟踪 main 分支): ```bash # Linux / macOS / WSL2 / Android (Termux) curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash ``` +安装脚本会在 `~/.hermes/hermes-agent` 创建一个受管理的隔离环境(独立的 uv 托管解释器和 venv),这是唯一受支持的安装方式 —— 包括开发用途。请勿使用 `pip install hermes-agent`。 + :::tip Android / Termux 如果你在手机上安装,请参阅专门的 [Termux 指南](./termux.md),其中包含经过测试的手动安装步骤、支持的扩展功能以及当前 Android 特有的限制。 ::: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/updating.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/updating.md index d922a9cb6d0..2fd205cb81a 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/updating.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/updating.md @@ -8,8 +8,6 @@ description: "如何将 Hermes Agent 更新至最新版本或将其卸载" ## 更新 -### Git 安装方式 - 使用单条命令更新至最新版本: ```bash @@ -18,26 +16,11 @@ hermes update 此命令会从 `main` 拉取最新代码、更新依赖项,并提示你配置自上次更新以来新增的选项。 -### pip 安装方式 - -PyPI 发布版本跟踪**带标签的版本**(主版本和次版本发布),而非 `main` 上的每次提交。检查更新并升级: - -```bash -hermes update --check # 查看 PyPI 上是否有更新的版本 -hermes update # 执行 pip install --upgrade hermes-agent -``` - -或手动执行: - -```bash -pip install --upgrade hermes-agent # 或:uv pip install --upgrade hermes-agent -``` - :::tip `hermes update` 会自动检测新的配置选项并提示你添加。如果跳过了该提示,可手动运行 `hermes config check` 查看缺失的选项,再运行 `hermes config migrate` 以交互方式添加。 ::: -### 更新过程(Git 安装方式) +### 更新过程 运行 `hermes update` 时,将依次执行以下步骤: @@ -49,7 +32,7 @@ pip install --upgrade hermes-agent # 或:uv pip install --upgrade hermes-ag ### 仅预览:`hermes update --check` -想在拉取前确认是否有更新?运行 `hermes update --check` — 对于 Git 安装方式,它会获取并与 `origin/main` 比较提交;对于 pip 安装方式,它会查询 PyPI 上的最新版本。不修改任何文件,不重启 gateway。适合在以"是否有更新"为条件的脚本和 cron 任务中使用。 +想在拉取前确认是否有更新?运行 `hermes update --check` — 它会获取并与 `origin/main` 比较提交。不修改任何文件,不重启 gateway。适合在以"是否有更新"为条件的脚本和 cron 任务中使用。 ### 完整更新前备份:`--backup` @@ -224,21 +207,12 @@ nix profile rollback ## 卸载 -### Git 安装方式 - ```bash hermes uninstall ``` 卸载程序会提供选项,让你保留配置文件(`~/.hermes/`)以便将来重新安装。 -### pip 安装方式 - -```bash -pip uninstall hermes-agent -rm -rf ~/.hermes # 可选 — 如计划重新安装则保留 -``` - ### 手动卸载 ```bash diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/aws-bedrock.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/aws-bedrock.md index 2bbbc257257..8c38ff065d5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/aws-bedrock.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/aws-bedrock.md @@ -15,7 +15,7 @@ Hermes Agent 通过 **Converse API** 原生支持 Amazon Bedrock——而非 Ope - `AWS_ACCESS_KEY_ID` + `AWS_SECRET_ACCESS_KEY` 环境变量 - `AWS_PROFILE`(用于 SSO 或命名配置文件) - `aws configure`(用于本地开发) -- **boto3** — 通过 `pip install hermes-agent[bedrock]` 安装 +- **boto3** — 通过 `cd ~/.hermes/hermes-agent && uv pip install -e ".[bedrock]"` 安装 - **IAM 权限** — 至少需要: - `bedrock:InvokeModel` 和 `bedrock:InvokeModelWithResponseStream`(用于推理) - `bedrock:ListFoundationModels` 和 `bedrock:ListInferenceProfiles`(用于模型发现) @@ -28,7 +28,7 @@ Hermes Agent 通过 **Converse API** 原生支持 Amazon Bedrock——而非 Ope ```bash # 安装并启用 Bedrock 支持 -pip install hermes-agent[bedrock] +cd ~/.hermes/hermes-agent && uv pip install -e ".[bedrock]" # 选择 Bedrock 作为提供商 hermes model diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/use-voice-mode-with-hermes.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/use-voice-mode-with-hermes.md index a3e8d949139..853e69310c7 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/use-voice-mode-with-hermes.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/guides/use-voice-mode-with-hermes.md @@ -57,19 +57,19 @@ What tools do you have available? ### CLI 麦克风 + 播放 ```bash -pip install "hermes-agent[voice]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[voice]" ``` ### 消息平台 ```bash -pip install "hermes-agent[messaging]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]" ``` ### 高级 ElevenLabs TTS ```bash -pip install "hermes-agent[tts-premium]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[tts-premium]" ``` ### 本地 NeuTTS(可选) @@ -81,7 +81,7 @@ python -m pip install -U neutts[all] ### 全部安装 ```bash -pip install "hermes-agent[all]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[all]" ``` ## 第三步:安装系统依赖 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/cli-commands.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/cli-commands.md index 0643d50a19e..8c2a8216937 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/cli-commands.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/cli-commands.md @@ -79,7 +79,7 @@ hermes [global-options] [subcommand/options] | `hermes profile` | 管理 profile——多个隔离的 Hermes 实例。 | | `hermes completion` | 打印 shell 补全脚本(bash/zsh/fish)。 | | `hermes version` | 显示版本信息。 | -| `hermes update` | 拉取最新代码并重新安装依赖(git 安装),或检查 PyPI 并执行 `pip install --upgrade`(pip 安装)。`--check` 预览而不安装;`--backup` 在拉取前对 `HERMES_HOME` 进行快照。 | +| `hermes update` | 拉取最新代码并重新安装依赖。`--check` 预览而不安装;`--backup` 在拉取前对 `HERMES_HOME` 进行快照。 | | `hermes uninstall` | 从系统中删除 Hermes。 | ## `hermes chat` @@ -974,7 +974,7 @@ python -m acp_adapter 首先安装支持: ```bash -pip install -e '.[acp]' +cd ~/.hermes/hermes-agent && uv pip install -e '.[acp]' ``` 参见 [ACP 编辑器集成](../user-guide/features/acp.md) 和 [ACP 内部原理](../developer-guide/acp-internals.md)。 @@ -1144,7 +1144,7 @@ hermes claw migrate --source /home/user/old-openclaw hermes dashboard [options] ``` -启动 Web 控制台——基于浏览器的界面,用于管理配置、API 密钥和监控会话。需要 `pip install hermes-agent[web]`(FastAPI + Uvicorn)。内嵌浏览器 Chat 标签页始终可用,但额外需要 `pty` extra(`pip install 'hermes-agent[web,pty]'`)以及 POSIX PTY 环境(如 Linux、macOS 或 WSL2)。完整文档请参阅 [Web 控制台](/user-guide/features/web-dashboard)。 +启动 Web 控制台——基于浏览器的界面,用于管理配置、API 密钥和监控会话。需要 `cd ~/.hermes/hermes-agent && uv pip install -e ".[web]"`(FastAPI + Uvicorn)。内嵌浏览器 Chat 标签页始终可用,但额外需要 `pty` extra(`cd ~/.hermes/hermes-agent && uv pip install -e ".[web,pty]"`)以及 POSIX PTY 环境(如 Linux、macOS 或 WSL2)。完整文档请参阅 [Web 控制台](/user-guide/features/web-dashboard)。 | 选项 | 默认值 | 说明 | |--------|---------|-------------| @@ -1227,9 +1227,7 @@ hermes completion fish > ~/.config/fish/completions/hermes.fish hermes update [--check] [--backup] [--restart-gateway] ``` -拉取最新的 `hermes-agent` 代码并在 venv 中重新安装依赖,然后重新运行安装后 hook(MCP 服务器、skill 同步、补全安装)。可在运行中的安装上安全执行。 - -**pip 安装:** `hermes update` 自动检测基于 pip 的安装——查询 PyPI 获取最新版本并运行 `pip install --upgrade hermes-agent`,而非 `git pull`。PyPI 发布跟踪标记版本(主要/次要版本),而非 `main` 上的每个 commit。使用 `--check` 查看是否有更新的 PyPI 版本可用,而不安装。 +拉取最新的 `hermes-agent` 代码并在受管理的 venv 中重新安装依赖,然后重新运行安装后 hook(MCP 服务器、skill 同步、补全安装)。可在运行中的安装上安全执行。使用 `--check` 查看你的检出是否落后于 `origin/main`,而不安装。 | 选项 | 说明 | |--------|-------------| diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/faq.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/faq.md index 2294119f36b..e1c39b9b1f0 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/faq.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/reference/faq.md @@ -437,7 +437,7 @@ cat ~/.hermes/logs/gateway.log | tail -50 **解决方案:** ```bash # 安装核心消息网关依赖项 -pip install "hermes-agent[messaging]" # Telegram、Discord、Slack 及共享网关依赖 +cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]" # Telegram、Discord、Slack 及共享网关依赖 # 检查端口冲突 lsof -i :8080 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/tts.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/tts.md index 1039e40a957..d13b4c1a9c5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/tts.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/tts.md @@ -422,7 +422,7 @@ stt: **OpenAI API** — 优先使用 `VOICE_TOOLS_OPENAI_KEY`,回退至 `OPENAI_API_KEY`。支持 `whisper-1`、`gpt-4o-mini-transcribe` 和 `gpt-4o-transcribe`。 -**Mistral API(Voxtral Transcribe)** — 需要 `MISTRAL_API_KEY`。使用 Mistral 的 [Voxtral Transcribe](https://docs.mistral.ai/capabilities/audio/speech_to_text/) 模型。支持 13 种语言、说话人分离和词级时间戳。通过 `pip install hermes-agent[mistral]` 安装。 +**Mistral API(Voxtral Transcribe)** — 需要 `MISTRAL_API_KEY`。使用 Mistral 的 [Voxtral Transcribe](https://docs.mistral.ai/capabilities/audio/speech_to_text/) 模型。支持 13 种语言、说话人分离和词级时间戳。通过 `cd ~/.hermes/hermes-agent && uv pip install -e ".[mistral]"` 安装。 **xAI Grok STT** — 需要 `XAI_API_KEY`。以 multipart/form-data 格式发送至 `https://api.x.ai/v1/stt`。如果你已在使用 xAI 进行聊天或 TTS 并希望一个 API 密钥搞定一切,这是个好选择。自动检测顺序将其排在 Groq 之后——显式设置 `stt.provider: xai` 可强制使用。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/voice-mode.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/voice-mode.md index 8c39422aa46..7e9c40beff9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/voice-mode.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/voice-mode.md @@ -14,7 +14,7 @@ Hermes Agent 支持在 CLI 和消息平台上进行完整的语音交互。通 使用语音功能前,请确保已完成以下准备: -1. **已安装 Hermes Agent** — `pip install hermes-agent`(参见 [安装](/getting-started/installation)) +1. **已安装 Hermes Agent** — 通过安装脚本(参见 [安装](/getting-started/installation)) 2. **已配置 LLM 提供商** — 运行 `hermes model` 或在 `~/.hermes/.env` 中设置首选提供商的凭据 3. **基础设置正常** — 运行 `hermes` 验证 Agent 能够响应文字消息,再启用语音功能 @@ -40,19 +40,19 @@ Hermes Agent 支持在 CLI 和消息平台上进行完整的语音交互。通 ```bash # CLI 语音模式(麦克风 + 音频播放) -pip install "hermes-agent[voice]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[voice]" # Discord + Telegram 消息(包含 discord.py[voice] 以支持语音频道) -pip install "hermes-agent[messaging]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]" # 高级 TTS(ElevenLabs) -pip install "hermes-agent[tts-premium]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[tts-premium]" # 本地 TTS(NeuTTS,可选) python -m pip install -U neutts[all] # 一次性安装所有内容 -pip install "hermes-agent[all]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[all]" ``` | 扩展包 | 包含的包 | 用途 | diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/web-dashboard.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/web-dashboard.md index 725eef2e7cd..7411c7d0ef5 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/web-dashboard.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/features/web-dashboard.md @@ -41,10 +41,10 @@ hermes dashboard --no-open 默认的 `hermes-agent` 安装不包含 HTTP 栈或 PTY 辅助工具——这些是可选扩展。**Web Dashboard** 需要 FastAPI 和 Uvicorn(`web` 扩展)。**Chat** 标签页还需要 `ptyprocess` 来在伪终端(pseudo-terminal)后面启动嵌入式 TUI(POSIX 上的 `pty` 扩展)。使用以下命令同时安装: ```bash -pip install 'hermes-agent[web,pty]' +cd ~/.hermes/hermes-agent && uv pip install -e ".[web,pty]" ``` -`web` 扩展会引入 FastAPI/Uvicorn;`pty` 扩展会引入 `ptyprocess`(POSIX)或 `pywinpty`(原生 Windows——注意嵌入式 TUI 本身仍需要 WSL)。`pip install hermes-agent[all]` 包含两个扩展,如果你还需要消息/语音等功能,这是最简便的方式。 +`web` 扩展会引入 FastAPI/Uvicorn;`pty` 扩展会引入 `ptyprocess`(POSIX)或 `pywinpty`(原生 Windows——注意嵌入式 TUI 本身仍需要 WSL)。`cd ~/.hermes/hermes-agent && uv pip install -e ".[all]"` 包含两个扩展,如果你还需要消息/语音等功能,这是最简便的方式。 在没有依赖项的情况下运行 `hermes dashboard` 时,它会告诉你需要安装什么。如果前端尚未构建且 `npm` 可用,则会在首次启动时自动构建。 @@ -80,7 +80,7 @@ Chat 标签页是每次 `hermes dashboard` 启动的一部分——内嵌的浏 **前置条件:** - Node.js(与 `hermes --tui` 相同的要求;TUI 包在首次启动时构建) -- `ptyprocess`——由 `pty` 扩展安装(`pip install 'hermes-agent[web,pty]'`,或 `[all]` 同时包含两者) +- `ptyprocess`——由 `pty` 扩展安装(`cd ~/.hermes/hermes-agent && uv pip install -e ".[web,pty]"`,或 `[all]` 同时包含两者) - POSIX 内核(Linux、macOS 或 WSL2)。`/chat` 终端面板特别需要 POSIX PTY——原生 Windows Python 没有等效实现,因此在原生 Windows 安装上,Dashboard 的其余部分(sessions、jobs、metrics、config editor)可以正常工作,但 `/chat` 标签页会显示提示,告知你需要使用 WSL2 才能使用该功能。 关闭浏览器标签页后,PTY 会在服务器端被干净地回收。重新打开会启动一个新会话。 diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/dingtalk.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/dingtalk.md index def0763f66d..366edd5863b 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/dingtalk.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/dingtalk.md @@ -44,7 +44,7 @@ group_sessions_per_user: false 安装所需的 Python 包: ```bash -pip install "hermes-agent[dingtalk]" +cd ~/.hermes/hermes-agent && uv pip install -e ".[dingtalk]" ``` 或单独安装: diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/matrix.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/matrix.md index 388f378d8eb..fd9c552bbc9 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/matrix.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/matrix.md @@ -246,7 +246,7 @@ E2EE 需要带有加密扩展的 `mautrix` 库以及 `libolm` C 库: pip install 'mautrix[encryption]' # 或通过 hermes extras 安装 -pip install 'hermes-agent[matrix]' +cd ~/.hermes/hermes-agent && uv pip install -e ".[matrix]" ``` 你还需要在系统上安装 `libolm`: @@ -427,7 +427,7 @@ pip install 'mautrix[encryption]' 或通过 Hermes extras: ```bash -pip install 'hermes-agent[matrix]' +cd ~/.hermes/hermes-agent && uv pip install -e ".[matrix]" ``` ### 加密错误/"无法解密事件" @@ -589,7 +589,7 @@ services: FROM python:3.11-slim RUN apt-get update && apt-get install -y libolm-dev && rm -rf /var/lib/apt/lists/* -RUN pip install 'hermes-agent[matrix]' +RUN cd ~/.hermes/hermes-agent && uv pip install -e ".[matrix]" CMD ["hermes", "gateway"] ``` diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/sms.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/sms.md index b40bd46a804..235e8f37890 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/sms.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/sms.md @@ -20,7 +20,7 @@ SMS gateway(网关)与可选的 [telephony skill](/reference/skills-catalog) - **Twilio 账户** — [在 twilio.com 注册](https://www.twilio.com/try-twilio)(提供免费试用) - **具备 SMS 功能的 Twilio 电话号码** - **可公开访问的服务器** — Twilio 在收到 SMS 时会向你的服务器发送 webhook -- **aiohttp** — `pip install 'hermes-agent[sms]'` +- **aiohttp** — `cd ~/.hermes/hermes-agent && uv pip install -e ".[sms]"` --- diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/weixin.md b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/weixin.md index 5ba2bf7fd67..b8bf74dd69c 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/weixin.md +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/messaging/weixin.md @@ -34,7 +34,7 @@ description: "通过 iLink Bot API 将 Hermes Agent 连接到个人微信账号" ```bash pip install aiohttp cryptography # 可选:用于终端二维码显示 -pip install hermes-agent[messaging] +cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]" ``` ## 配置步骤 @@ -309,4 +309,4 @@ iLink Bot API 要求在每条出站消息中回传 `context_token`(针对特 | 语音消息显示为文本 | 若微信提供了转录文本,适配器会使用文本内容,这是预期行为 | | 消息出现重复 | 适配器通过消息 ID 去重。若仍出现重复,检查是否有多个网关实例在运行 | | `iLink POST ... HTTP 4xx/5xx` | iLink 服务返回 API 错误。检查 token 有效性和网络连通性 | -| 终端二维码无法渲染 | 使用 messaging 扩展重新安装:`pip install hermes-agent[messaging]`。或者,打开二维码上方打印的 URL | \ No newline at end of file +| 终端二维码无法渲染 | 使用 messaging 扩展重新安装:`cd ~/.hermes/hermes-agent && uv pip install -e ".[messaging]"`。或者,打开二维码上方打印的 URL | \ No newline at end of file