Skip to content

fix(docs): target installer venv in voice extra install command - #44367

Closed
liuhao1024 wants to merge 1 commit into
NousResearch:mainfrom
liuhao1024:fix/voice-venv-install-docs
Closed

fix(docs): target installer venv in voice extra install command#44367
liuhao1024 wants to merge 1 commit into
NousResearch:mainfrom
liuhao1024:fix/voice-venv-install-docs

Conversation

@liuhao1024

Copy link
Copy Markdown
Contributor

What does this PR do?

Fixes the voice-mode extra install command in the quickstart docs to target the installer-created virtual environment explicitly, preventing failures on fresh curl-installed setups where no venv is active.

Related Issue

Fixes #44364

Type of Change

  • 📝 Documentation update

Changes Made

  • website/docs/getting-started/quickstart.md: Changed uv pip install -e ".[voice]" to uv pip install --python ./venv/bin/python -e ".[voice]" so it targets the installer-created venv without requiring manual activation.
  • website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/getting-started/quickstart.md: Same fix for the Chinese localization.

How to Test

  1. On a fresh system (or simulate by deactivating any venv), cd ~/.hermes/hermes-agent
  2. Run uv pip install --python ./venv/bin/python -e ".[voice]" — it should install successfully
  3. Verify faster-whisper, sounddevice, and numpy are installed in the venv: ./venv/bin/python -c "import faster_whisper; print('OK')"

Checklist

Code

  • I've read the Contributing Guide
  • My commit messages follow Conventional Commits (fix(scope):, feat(scope):, etc.)
  • I searched for existing PRs to make sure this isn't a duplicate
  • My PR contains only changes related to this fix/feature (no unrelated commits)
  • I've run pytest tests/ -q and all tests pass
  • I've added tests for my changes (N/A — documentation only)
  • I've tested on my platform: macOS

Documentation & Housekeeping

  • I've updated relevant documentation (README, docs/, docstrings)
  • I've updated cli-config.yaml.example if I added/changed config keys — N/A
  • I've updated CONTRIBUTING.md or AGENTS.md if I changed architecture or workflows — N/A
  • I've considered cross-platform impact (Windows, macOS) per the compatibility guide — N/A (docs-only)
  • I've updated tool descriptions/schemas if I changed tool behavior — N/A

Code Intelligence

  • Analyzed: website/docs/getting-started/quickstart.md (voice-mode section, line 267-275)
  • Blast radius: LOW — documentation-only change, no code behavior affected
  • Related patterns: The same uv pip install without --python pattern exists in MCP and ACP sections of the same file, but those are out of scope for this issue

The quickstart voice-mode section used `uv pip install -e ".[voice]"`
which fails on a fresh curl-installed setup because no virtual environment
is active. Use `--python ./venv/bin/python` to target the installer-created
venv explicitly, matching the curl installer layout.

Fixes NousResearch#44364
@alt-glitch alt-glitch added type/docs Documentation improvements comp/cli CLI entry point, hermes_cli/, setup wizard P3 Low — cosmetic, nice to have labels Jun 11, 2026

@tonydwb tonydwb left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review Summary

Verdict: Approved

Summary

Fixes the voice extra install command to target the installer venv instead of the runtime venv.

Review

  • Correct path fix for the voice extra installation instructions.
  • No security concerns.

Reviewed by Hermes Agent (batch cron)

@teknium1 teknium1 added sweeper:risk-platform-windows Sweeper risk: may break or behave differently on native Windows sweeper:risk-compatibility Sweeper risk: may break existing users, config, migrations, defaults, or upgrades sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users area/install-update Installer, updater, packaging, wheels, doctor labels Jul 14, 2026
@teknium1

Copy link
Copy Markdown
Contributor

Merged into main via consolidated salvage PR #73520 (merge e04c2a9ebd). Your docs fix targeting the installer venv for the voice extra was cherry-picked with your authorship.

Your contribution is credited to you in git history. Thank you! Closing this PR as merged-via-salvage.

@teknium1 teknium1 closed this Jul 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/install-update Installer, updater, packaging, wheels, doctor comp/cli CLI entry point, hermes_cli/, setup wizard P3 Low — cosmetic, nice to have sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users sweeper:risk-compatibility Sweeper risk: may break existing users, config, migrations, defaults, or upgrades sweeper:risk-platform-windows Sweeper risk: may break or behave differently on native Windows type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: voice extra install command fails unless installer venv is activated or targeted

4 participants