Skip to main content

Voice-first terminal overlay for Codex and Claude with local Whisper STT, PTY passthrough, and a customizable HUD

Project description

VoiceTerm

Voice-first terminal overlay for Codex and Claude. Local Whisper speech-to-text runs on your machine by default, with PTY passthrough and a customizable HUD.

Primary support: Codex and Claude Code.

Install

pipx install voiceterm
# or
python3 -m pip install --user voiceterm

Then run:

voiceterm

Authenticate your backend once if needed:

voiceterm --login --codex
voiceterm --login --claude

What This Package Does

The PyPI package installs the voiceterm launcher.

On first run, it bootstraps the native VoiceTerm binary into:

  • ~/.local/share/voiceterm/native/bin/voiceterm (default)

By default it downloads a prebuilt release binary from the matching GitHub release tag (v<package-version>), verifies the SHA256 checksum, and installs it locally.

Default mode: VOICETERM_BOOTSTRAP_MODE=binary-only

Runtime Requirements

  • Internet access to GitHub Releases (or a configured mirror)
  • macOS or Linux (Windows via WSL2)

Source-build fallback requirements (only when enabled):

  • git
  • Rust toolchain (cargo, rustc)

Optional Environment Overrides

  • VOICETERM_NATIVE_BIN=/absolute/path/to/voiceterm
    • Use an already-installed native binary and skip bootstrap.
  • VOICETERM_PY_NATIVE_ROOT=/custom/root
    • Change where the bootstrap binary is installed.
  • VOICETERM_BOOTSTRAP_MODE=binary-only|binary-then-source|source-only
    • Choose bootstrap strategy.
  • VOICETERM_RELEASE_OWNER_REPO=jguida941/voiceterm
    • Override GitHub owner/repo used for release binary downloads.
  • VOICETERM_RELEASE_BASE_URL=https://github.com/jguida941/voiceterm/releases/download
    • Override release download base URL (for mirror/proxy setups).
  • VOICETERM_REPO_URL=https://github.com/jguida941/voiceterm
    • Use a different source repository URL (source-bootstrap modes only).
  • VOICETERM_REPO_REF=v1.0.69
    • Override release tag for binary mode or git ref for source-bootstrap modes.

Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

voiceterm-1.0.94.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

voiceterm-1.0.94-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file voiceterm-1.0.94.tar.gz.

File metadata

  • Download URL: voiceterm-1.0.94.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for voiceterm-1.0.94.tar.gz
Algorithm Hash digest
SHA256 4d4d9ddc8733e1e2821115953287c28d0524050b7fd8b8cafdff91e1820acd7e
MD5 a662b237899bdd8fb18fc8113ceb3121
BLAKE2b-256 9a7aacaefd4ae83f39caa90fd08a6f91e4d29ded170734d37307e264bc378013

See more details on using hashes here.

File details

Details for the file voiceterm-1.0.94-py3-none-any.whl.

File metadata

  • Download URL: voiceterm-1.0.94-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for voiceterm-1.0.94-py3-none-any.whl
Algorithm Hash digest
SHA256 3cf64867119861c10839e85051bfe7bf7fdb91415f450ee7997c01ae001052d9
MD5 a33bccf1a270e9e5e5a17fb95be5d85e
BLAKE2b-256 41b28beec00d911be50b14f3495286fb281de467f8b2e3c1963d130cbd496c2f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page