handsfreectl

handsfreectl is the command-line control interface for the Handsfree speech-to-text daemon (handsfreed). It allows you to start and stop transcription, check the daemon's status, and more.

Overview

This tool provides a simple way to interact with the handsfreed daemon from the command line, making it easy to integrate with scripts, keyboard shortcuts, or other tools in a Linux desktop environment.

Installation

handsfreectl is written in Rust and can be built from source using Cargo.

Prerequisites:

• Rust: Version 1.85.0 or newer.

Steps:

1. Clone the Repository:

   git clone https://github.com/achyudh/handsfreectl.git
   cd handsfreectl
   

2. Build:

   cargo build --release
   

3. Install: Copy the compiled binary to a directory in your $PATH:

   sudo cp target/release/handsfreectl /usr/local/bin/
   

Usage

handsfreectl communicates with the handsfreed daemon, which must be running for these commands to work.

• Start Transcription: Tells the daemon to start listening for speech. The transcribed text can be output as simulated keyboard input or copied to the clipboard, depending on the daemon's configuration.

  handsfreectl start --output keyboard
  handsfreectl start --output clipboard
  

• Stop Transcription: Tells the daemon to stop the current listening session.

  handsfreectl stop
  

• Check Status: Queries the daemon's current state.

  handsfreectl status
  

  Possible outputs include Idle, Listening, Processing, Error, or Inactive.

• Shutdown Daemon: Tells the handsfreed process to shut down cleanly.

  handsfreectl shutdown
  

License

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