handsfreed 0.1.0

Handsfree speech-to-text daemon for Linux

handsfreed

handsfreed is a local, real-time speech-to-text daemon for Linux. It uses the faster-whisper library to provide high-quality, offline transcription.

This package is the daemon component of the Handsfree project. It is controlled by the handsfreectl command-line tool.

Installation

Manual Installation

handsfreed requires PortAudio, which is a dependency of the sounddevice Python library. You must install the PortAudio library and its development headers using your system's package manager.

• Debian/Ubuntu:

  sudo apt-get install libportaudio2 libportaudiocpp0 portaudio19-dev
  

• Fedora/CentOS/RHEL:

  sudo dnf install portaudio-devel
  

• Arch Linux:

  sudo pacman -S portaudio
  

Once the system dependencies are installed, you can install handsfreed using pip:

pip install handsfreed

Nix Flake

If you are using Nix with Flakes enabled, handsfreed can be installed by following the instructions here.

Usage

handsfreed is designed to be run as a background service.

1. Create a configuration file: Create a configuration file at ~/.config/handsfree/config.toml. You can start with the example configuration.

2. Run the daemon:

   handsfreed
   

   The daemon will start listening for commands from handsfreectl.

3. Control with handsfreectl: Use the handsfreectl CLI to start/stop transcription and check the status of the daemon. You must install it separately.

Configuration

handsfreed is configured via a TOML file located at ~/.config/handsfree/config.toml. The configuration allows you to set up your audio input, Whisper model, VAD parameters, and more.

For a full list of configuration options, please see the example configuration file.

License

This project is licensed under the GNU General Public License v3.0.