VoiceUse / Docs / Installation

Installation

VoiceUse can be installed in several ways depending on your needs. The full voice assistant requires audio, STT, TTS, and LLM dependencies. The lightweight MCP server only needs core OS control libraries.

Quick Install

pipx (Recommended)

# Full voice assistant
pipx install "voice-computer-use-agent[all]"

# MCP server only
pipx install voice-computer-use-agent

uv

# Full voice assistant
uv tool install "voice-computer-use-agent[all]"

# MCP server only
uv tool install voice-computer-use-agent

pip

# Full voice assistant
pip install "voice-computer-use-agent[all]"

# MCP server only
pip install voice-computer-use-agent

Development Install

Clone the repository and install in editable mode:

git clone https://github.com/jarmen423/voice-computer-use-agent.git
cd voice-computer-use-agent

# Create virtual environment
python -m venv .venv

# Windows
.venv\Scripts\activate

# macOS / Linux
source .venv/bin/activate

# Install with dev dependencies
pip install -e ".[dev]"

Per-OS Setup

Windows (Primary)

Windows is the primary supported platform with full feature parity.

Prerequisites:

If pyaudio fails to install:

pip install pipwin
pipwin install pyaudio

Install ffmpeg:

  1. Download from ffmpeg.org
  2. Add bin folder to your PATH
  3. Verify: ffmpeg -version

Linux

Debian / Ubuntu

sudo apt-get update
sudo apt-get install -y \
    python3-pyaudio portaudio19-dev \
    python3-xlib xdotool wmctrl ffmpeg

Arch

sudo pacman -S python-pyaudio portaudio xdotool wmctrl ffmpeg
Wayland Support

xdotool may not work on Wayland. Switch to X11 or use XWayland for full compatibility.

macOS (Best-Effort)

brew install portaudio ffmpeg

PyInstaller Binaries

Standalone executables are available from GitHub Releases:

PlatformFileSize
WindowsVoiceUse-Windows-x64.exe~45 MB
macOSVoiceUse-macOS-universal.app.zip~52 MB
LinuxVoiceUse-Linux-x86_64~48 MB

No Python installation required for these builds.

Verify Installation

# Check all dependencies
python -m voiceuse --check-install

# Dry-run mode (no API calls)
python -m voiceuse --dry-run

# Show help
python -m voiceuse --help

Available Commands

After installation, two console commands are available:

CommandPurpose
voiceuseMain voice assistant
voiceuse-computer-control-mcpMCP server for Codex/other agents