### Voxtype Initial Setup and Start

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Commands to ensure input group membership, run the setup wizard for dependencies and model download, and start the Voxtype application.

```bash
# 1. Ensure you're in the input group
groups | grep input

# 2. Run the setup wizard
voxtype setup --download

# 3. Start voxtype
voxtype
```

--------------------------------

### Install Vocalinux from Source

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/vocalinux.html

Clones the Vocalinux repository, runs the install script, and activates the Python virtual environment. This is the initial setup for Vocalinux.

```bash
git clone https://github.com/jatinkrmalik/vocalinux.git
cd vocalinux
./install.sh
source venv/bin/activate
vocaliux
```

--------------------------------

### Install and Setup VOXD

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/voxd.html

Installs VOXD using paru or a .deb package. The first run triggers an interactive setup wizard for voice model, LLM model, and ydotool configuration. For Wayland, a separate setup script is required.

```bash
# Install
paru -S voxd
# Or: sudo dpkg -i voxd_*.deb

# First run triggers setup wizard
voxd
# Configures: voice model, LLM model, ydotool

# For Wayland, also run:
./setup_ydotool.sh
# Then log out and back in
```

--------------------------------

### Voxtype Installation and Setup

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/waystt.html

Install Voxtype using paru, set up the transcription model, enable the systemd user service, and start it. After setup, hotkey dictation is ready.

```bash
paru -S voxtype
voxtype setup model
voxtype setup systemd
systemctl --user enable --now voxtype
```

--------------------------------

### Verify Voxtype Installation

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL.md

Run the setup command to verify that all necessary components and configurations are in place after installation.

```bash
voxtype setup
```

--------------------------------

### Install Quickshell Frontend

Source: https://github.com/peteonrails/voxtype/blob/dev/quickshell/README.md

Installs the Quickshell frontend and its dependencies. This command copies QML files, symlinks the audio bridge, and provides compositor binding examples. Use --help for advanced options.

```bash
voxtype setup quickshell
```

--------------------------------

### Setup Quickshell Frontend

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

Install the QML tree for the Quickshell frontend. This command copies QML files and symlinks the audio bridge if necessary.

```bash
voxtype setup quickshell

```

--------------------------------

### VoxInput Setup with LocalAI via Docker

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/voxinput.html

Installs and runs LocalAI using Docker, then guides through installing transcription models and building VoxInput.

```bash
# Install LocalAI via Docker
docker run -d --name localai -p 8080:8080 localai/localai

# Install whisper model via LocalAI web UI
# Open http://localhost:8080, install whisper-1 and silero-vad-ggml

# Install dotool and configure udev rules
# Add user to input group

# Build VoxInput
git clone https://github.com/richiejp/VoxInput
cd VoxInput && go build -o voxinput

# Configure WM keybinds for record/write commands
```

--------------------------------

### Install and Setup hyprwhspr on Arch

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/hyprwhspr.html

Installs hyprwhspr using yay and initiates its interactive setup process. Users should follow the on-screen prompts for configuration.

```bash
yay -S hyprwhspr
hyprwhspr setup
# Follow interactive prompts
```

--------------------------------

### Install and start ydotool for X11

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Install ydotool for type mode on X11. Ensure the ydotool daemon is enabled and running for it to function correctly.

```bash
# Install and start ydotool
# Fedora: sudo dnf install ydotool
# Arch: sudo pacman -S ydotool
# Ubuntu: sudo apt install ydotool
systemctl --user enable --now ydotool
```

--------------------------------

### Install and Setup Voxtype on Arch

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/hyprwhspr.html

Installs Voxtype using paru, guides through interactive model selection, and sets up the systemd service. Optional Waybar configuration is also shown.

```bash
paru -S voxtype
voxtype setup model     # Interactive model selection
voxtype setup systemd   # Install systemd service
voxtype setup waybar    # Get Waybar config (optional)
```

--------------------------------

### Install dotool from Source

Source: https://github.com/peteonrails/voxtype/blob/dev/website/news/index.html

Clone the dotool repository, compile, and install it from source.

```bash
git clone https://git.sr.ht/~geb/dotool
cd dotool && make && sudo make install
```

--------------------------------

### Hyprland Keybinding for Recording Start

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

Example Hyprland configuration to bind a key combination (Super+V) to start voxtype recording via the CLI.

```hyprlang
bind = SUPER, V, exec, voxtype record start
```

--------------------------------

### Sway Keybinding for Recording Start

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

Example Sway configuration to bind a key combination ($mod+v) to start voxtype recording via the CLI.

```bash
bindsym $mod+v exec voxtype record start
```

--------------------------------

### Build SwiftUI Setup App

Source: https://github.com/peteonrails/voxtype/blob/dev/macos/RELEASE_PLAN.md

Navigate to the macOS setup app directory and execute the build script. This compiles the SwiftUI application used for setup.

```bash
cd macos/VoxtypeSetup && ./build-app.sh
```

--------------------------------

### Install and Run Voxtype using AppImage

Source: https://github.com/peteonrails/voxtype/blob/dev/README.md

Download and execute the AppImage for universal Linux installation. Make the AppImage executable, move it to a permanent location, and run the setup command to initialize the service.

```bash
# Download the appropriate AppImage from the GitHub release
chmod +x voxtype-*-x86_64.AppImage

# Move to a permanent location
mv voxtype-*-x86_64.AppImage ~/.local/bin/voxtype

# Run setup (downloads model, configures service)
~/.local/bin/voxtype setup
```

--------------------------------

### Runtime Test: Setup ONNX Subcommand

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/smoke_tests/v076/setup-retry-hint.md

Execute the 'setup onnx' command and verify that the retry hint correctly suggests 'sudo voxtype setup onnx --enable'. This test requires un-cached sudo and appropriate user permissions.

```bash
voxtype setup onnx --enable 2>&1 | grep "Try:"
# Expected: Try: sudo voxtype setup onnx --enable
```

--------------------------------

### Runtime Test: Setup GPU Subcommand

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/smoke_tests/v076/setup-retry-hint.md

Execute the 'setup gpu' command and verify that the retry hint correctly suggests 'sudo voxtype setup gpu --enable'. This test requires un-cached sudo and appropriate user permissions.

```bash
voxtype setup gpu --enable 2>&1 | grep "Try:"
# Expected: Try: sudo voxtype setup gpu --enable
```

--------------------------------

### Install and enable ydotool daemon for X11

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/TROUBLESHOOTING.md

Install ydotool for Ubuntu/Debian. Enable and start the systemd user daemon for ydotool to function.

```bash
# Ubuntu/Debian:
sudo apt install ydotool

# Start the daemon (see "ydotool daemon not running" section for Fedora)
systemctl --user enable --now ydotool
```

--------------------------------

### Notification Example for Output Hooks

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

Use pre_output_command and post_output_command to trigger desktop notifications when typing starts and finishes.

```toml
[output]
# Notification when typing starts/finishes
pre_output_command = "notify-send 'Typing...'"
post_output_command = "notify-send 'Done'"
```

--------------------------------

### Install Voxtype via Homebrew (macOS)

Source: https://github.com/peteonrails/voxtype/blob/dev/website/index.html

Installs the signed app bundle for Apple Silicon via Homebrew. The first launch initiates a setup wizard for permissions and model downloads.

```bash
# Install the signed app bundle
brew install --cask voxtype

# First launch opens a setup wizard that walks you through
# Accessibility permissions, model download, and the FN-key hotkey.
```

--------------------------------

### Start Meeting Commands

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/MEETING_MODE.md

Demonstrates various ways to start a meeting, including with and without a title.

```bash
voxtype meeting start
voxtype meeting start --title "Project Kickoff"
voxtype meeting start -t "1:1 with Alice"
```

--------------------------------

### Start and Enable Ydotool Daemon

Source: https://github.com/peteonrails/voxtype/blob/dev/README.md

If using ydotool as a fallback, start its systemd user service and enable it to start on login.

```bash
systemctl --user start ydotool
systemctl --user enable ydotool  # Start on login
```

--------------------------------

### Complete Cohere Configuration Example

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

A comprehensive example demonstrating how to configure the Cohere engine with model, language, and on-demand loading settings.

```toml
engine = "cohere"

[cohere]
model = "cohere-transcribe-q4f16"
language = "en"
on_demand_loading = false
```

--------------------------------

### Install Rust for Building from Source

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL.md

Installs Rust using the official script, a prerequisite for building Voxtype from source.

```bash
# 1. Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

--------------------------------

### Start Recording with a Profile

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Specify a profile when starting a recording using the `voxtype record start` command. This applies the profile's configuration to the current recording session.

```bash
# Use the slack profile for this recording
voxtype record start --profile slack
voxtype record stop

# Or with toggle mode
voxtype record toggle --profile code

```

--------------------------------

### Run Voxtype OSD Quickshell Launcher

Source: https://github.com/peteonrails/voxtype/blob/dev/quickshell/README.md

Launches the Voxtype OSD Quickshell frontend. This command finds the installed QML tree and starts the frontend. It can be run directly from a repository checkout during development.

```bash
voxtype-osd-quickshell
```

--------------------------------

### Setup ONNX Engines

Source: https://github.com/peteonrails/voxtype/blob/dev/website/news/index.html

The command to manage ONNX-based engines has been renamed from `setup parakeet` to `setup onnx`. The old command still works as an alias.

```bash
# New name
voxtype setup onnx

# Old name still works
voxtype setup parakeet
```

--------------------------------

### Install Hammerspoon

Source: https://github.com/peteonrails/voxtype/blob/dev/contrib/hammerspoon/README.md

Install Hammerspoon using Homebrew.

```bash
brew install --cask hammerspoon
```

--------------------------------

### Install and Test wl-clipboard

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/TROUBLESHOOTING.md

Provides package installation commands for wl-clipboard on different Linux distributions and tests its basic functionality.

```bash
# Install wl-clipboard
# Arch: sudo pacman -S wl-clipboard
# Debian: sudo apt install wl-clipboard
# Fedora: sudo dnf install wl-clipboard

# Test it works
echo "test" | wl-copy
wl-paste
```

--------------------------------

### Download Whisper Model

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL.md

Initiates the download of a Whisper model. Use 'voxtype setup' for interactive setup, 'voxtype setup --download' to download the default model, or 'voxtype setup model' to choose interactively.

```bash
# Interactive: checks the install and offers to download
voxtype setup

# Or directly download the default (base.en, 142 MB)
voxtype setup --download

# Or pick another model interactively
voxtype setup model
```

--------------------------------

### Download and Install Parakeet Binary

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/PARAKEET.md

Manually download the Parakeet-enabled voxtype binary for your CPU architecture. This is a temporary step until automated setup is available.

```bash
# Download the Parakeet binary for your CPU
# Example: AVX-512 capable CPU
curl -L https://github.com/peteonrails/voxtype/releases/download/v0.6.3/voxtype-0.6.3-linux-x86_64-onnx-avx512 \
  -o /tmp/voxtype-onnx

# Make executable and install
chmod +x /tmp/voxtype-onnx
sudo mv /tmp/voxtype-onnx /usr/local/bin/voxtype

# Restart the daemon
systemctl --user restart voxtype

# Verify
voxtype --version
```

--------------------------------

### Install wtype for Wayland Input

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL.md

For Wayland compositors, install 'wtype'. For KDE/GNOME, 'dotool' might be an alternative.

```bash
sudo apt install wtype     # or pacman -S / dnf install
```

--------------------------------

### Check wtype Installation and Test

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/FAQ.md

Ensure wtype is installed and test its direct text input functionality on Wayland.

```bash
which wtype
```

```bash
wtype "test"
```

--------------------------------

### Install Typing Backend (Wayland)

Source: https://github.com/peteonrails/voxtype/blob/dev/README.md

Installs the 'wtype' package, which is required for the Wayland typing backend. Choose the command appropriate for your distribution.

```bash
# 3. Install typing backend (Wayland)
# Fedora:
sudo dnf install wtype
# Arch:
sudo pacman -S wtype
# Ubuntu:
sudo apt install wtype
```

--------------------------------

### Install Built Voxtype Binary

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL.md

Installs the compiled Voxtype binary to the system's PATH.

```bash
# 4. Install
sudo install -Dm755 target/release/voxtype /usr/local/bin/voxtype
```

--------------------------------

### Install Quickshell QML Tree

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Installs the Quickshell QML tree for voxtype-osd-quickshell. Supports custom targets, source overrides, and bridge configuration. Use --force to overwrite existing installations.

```bash
voxtype setup quickshell                       # Install QML + symlink the bridge
voxtype setup quickshell --target DIR          # Install QML to a custom location
voxtype setup quickshell --source DIR          # Override the source tree (default: auto-detect)
voxtype setup quickshell --force               # Overwrite an existing install
voxtype setup quickshell --print-bindings      # Print the bindings only, do not copy
voxtype setup quickshell --bridge PATH         # Override the audio-bridge source binary
voxtype setup quickshell --bridge-target PATH  # Override the audio-bridge symlink location
voxtype setup quickshell --skip-bridge         # Skip the audio-bridge symlink entirely
```

--------------------------------

### Install Voxtype with Zypper (openSUSE)

Source: https://github.com/peteonrails/voxtype/blob/dev/website/download/index.html

Install Voxtype on openSUSE using the Zypper package manager.

```bash
sudo zypper install voxtype
```

--------------------------------

### Install Voxtype with Nix

Source: https://github.com/peteonrails/voxtype/blob/dev/website/download/index.html

Install Voxtype using Nix, a purely functional package manager.

```bash
nix-env -iA nixpkgs.voxtype
```

--------------------------------

### Voxtype Setup Subcommands

Source: https://github.com/peteonrails/voxtype/blob/dev/README.md

Illustrates various setup subcommands for dependency checks, model downloads, system service management, Waybar configuration, model selection, GPU acceleration, and engine switching.

```bash
voxtype setup

```

```bash
voxtype setup --download

```

```bash
voxtype setup systemd

```

```bash
voxtype setup waybar

```

```bash
voxtype setup model

```

```bash
voxtype setup gpu

```

```bash
voxtype setup onnx

```

--------------------------------

### Install Voxtype as a Systemd Service

Source: https://github.com/peteonrails/voxtype/blob/dev/website/index.html

Installs Voxtype as a systemd service, ensuring it starts automatically on login or boot. This command is used for both compositor-based and general desktop setups.

```bash
voxtype setup systemd
```

--------------------------------

### Hyprland Compositor Keybinding Example

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

Example of how to configure keybindings in Hyprland's configuration file to control Voxtype recording.

```hyprlang
bind = SUPER, V, exec, voxtype record start
bindr = SUPER, V, exec, voxtype record stop

```

--------------------------------

### Start Recording to Clipboard

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Starts a recording session and directs the transcription output to the system clipboard instead of typing.

```bash
voxtype record start --clipboard  # Output to clipboard instead of typing
```

--------------------------------

### Enable and start ydotool service

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/FAQ.md

Enable and start the ydotool user service. This is an alternative for text output when wtype is not supported and dotool is not preferred.

```bash
systemctl --user enable --now ydotool
```

--------------------------------

### Install Dependencies on Ubuntu/Debian

Source: https://github.com/peteonrails/voxtype/blob/dev/README.md

Installs the 'wtype' and 'wl-clipboard' packages on Ubuntu or Debian-based systems. These are runtime dependencies for Voxtype.

```bash
sudo apt install wtype wl-clipboard
```

--------------------------------

### Install dotool for X11

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/TROUBLESHOOTING.md

Install dotool from source for Ubuntu/Debian, or from the AUR for Arch. Ensure your user is in the 'input' group and log out/in.

```bash
# Ubuntu/Debian (from source):
sudo apt install libxkbcommon-dev
git clone https://git.sr.ht/~geb/dotool
cd dotool && ./build.sh && sudo cp dotool /usr/local/bin/

# Arch (AUR):
yay -S dotool

# Add user to input group
sudo usermod -aG input $USER
# Log out and back in
```

--------------------------------

### Install Voxtype via Homebrew Cask

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL_MACOS.md

Installs the Voxtype application using Homebrew Cask. This command handles the installation of the app, CLI symlink, auto-start, and daemon setup.

```bash
brew install --cask peteonrails/voxtype/voxtype
```

--------------------------------

### Install Voxtype and wtype from AUR

Source: https://github.com/peteonrails/voxtype/blob/dev/contrib/manjaro-sway/README.md

Install the necessary packages, voxtype and wtype, from the Arch User Repository (AUR) using yay.

```bash
# Install from AUR
yay -S voxtype wtype
```

--------------------------------

### Install xclip for X11 clipboard mode

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/TROUBLESHOOTING.md

Install xclip on Ubuntu/Debian systems to enable clipboard-only output mode in Voxtype.

```bash
# Ubuntu/Debian:
sudo apt install xclip
```

--------------------------------

### Start Recording to File via CLI

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

Starts recording and directs the transcription output to a specified file. Useful for saving transcriptions directly.

```bash
voxtype record start --file=out.txt # Write transcription to a file
```

--------------------------------

### Clone and Install WhisperWriter

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/whisperwriter.html

Clones the WhisperWriter repository and installs its Python dependencies. CUDA setup might be required for GPU acceleration.

```bash
git clone https://github.com/savbell/whisper-writer
cd whisper-writer
pip install -r requirements.txt
```

--------------------------------

### Compositor Integration Example

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

Configure both pre_output_command and post_output_command for seamless compositor integration, blocking modifiers before typing and restoring them afterward.

```toml
[output]
# Switch to modifier-blocking submap before typing
pre_output_command = "hyprctl dispatch submap voxtype_suppress"
# Return to normal submap after typing
post_output_command = "hyprctl dispatch submap reset"
```

--------------------------------

### Complete Waybar Configuration Example

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/WAYBAR.md

A full Waybar configuration snippet including the custom Voxtype module, clock, and pulseaudio modules. Uses `--follow` mode for instant updates.

```json
{
    "layer": "top",
    "position": "top",
    "modules-left": ["sway/workspaces"],
    "modules-center": ["sway/window"],
    "modules-right": ["custom/voxtype", "pulseaudio", "clock"],

    "custom/voxtype": {
        "exec": "voxtype status --follow --format json",
        "return-type": "json",
        "format": "{}",
        "tooltip": true
    },

    "clock": {
        "format": "{:%H:%M}"
    },

    "pulseaudio": {
        "format": "{volume}%"
    }
}
```

--------------------------------

### Example: Context-Aware Dictation Configuration

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Define default post-processing settings and then override them with specific profiles for different use cases like Slack, code comments, or meeting notes. This example shows how to set a default command and then customize profiles for specific output requirements.

```toml
# Default post-processing for general use
[output.post_process]
command = "ollama run llama3.2:1b 'Clean up grammar and punctuation:'"
timeout_ms = 30000

# Slack: casual, concise
[profiles.slack]
post_process_command = "ollama run llama3.2:1b 'Rewrite for Slack. Casual tone, keep it brief:'"

# Code: technical, clipboard output (for pasting into IDE)
[profiles.code]
post_process_command = "ollama run llama3.2:1b 'Format as a code comment in the style of the surrounding code:'"
output_mode = "clipboard"

# Meeting notes: bullet points
[profiles.notes]
post_process_command = "ollama run llama3.2:1b 'Convert to bullet points. Be concise:'"

```

--------------------------------

### Build Voxtype from Source

Source: https://github.com/peteonrails/voxtype/blob/dev/website/index.html

Compiles Voxtype from source, including Rust installation and build dependency setup for Fedora, Arch, and Debian/Ubuntu. Details commands for cloning, building, and installing.

```bash
# Install Rust (if needed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install build dependencies
#   Fedora:
sudo dnf install rust cargo alsa-lib-devel clang-devel cmake pkgconf
#   Arch:
sudo pacman -S rustup alsa-lib clang cmake pkgconf
#   Debian/Ubuntu:
sudo apt install cargo libasound2-dev libclang-dev cmake pkg-config

# Clone and build
git clone https://github.com/peteonrails/voxtype
cd voxtype
cargo build --release

# Install
sudo cp target/release/voxtype /usr/local/bin/
```

--------------------------------

### Complete Moonshine Configuration Example

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

An example demonstrating a full configuration for the Moonshine engine, including model selection, quantization, and on-demand loading settings.

```toml
engine = "moonshine"

[moonshine]
model = "base"
quantized = true
on_demand_loading = false  # Keep model loaded for fast response
```

--------------------------------

### Autostart with Sway/i3

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Add Voxtype to the configuration file of Sway or i3 window managers to start it automatically.

```bash
exec --no-startup-id voxtype
```

--------------------------------

### Autostart with Hyprland

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Add Voxtype to the hyprland.conf file to start it once when Hyprland launches.

```bash
exec-once = voxtype
```

--------------------------------

### Build and Run whisper.cpp Server

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Clone the whisper.cpp repository, build the server, download a model, and run the server. Adjust the build command for GPU acceleration.

```bash
# Clone whisper.cpp
git clone https://github.com/ggerganov/whisper.cpp
cd whisper.cpp

# Build the server
make server

# Download a model
./models/download-ggml-model.sh large-v3-turbo

# Run the server (adjust for your GPU)
./server -m models/ggml-large-v3-turbo.bin --host 0.0.0.0 --port 8080

```

--------------------------------

### Start and Stop Recording

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/smoke_tests/recording-cycle.md

Initiates a recording, waits for 3 seconds, and then stops the recording. This is a basic example of the record cycle.

```bash
# Basic record start/stop
voxtype record start
sleep 3
voxtype record stop
```

--------------------------------

### Check Available Output Methods

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/smoke_tests/output-chain-verification.md

Use this command to list all available output methods and their installation status. Check the output to ensure all expected methods are installed.

```bash
# Check which output methods are available:
voxtype config | grep -A10 "Output Chain"

# Expected output shows installed status for each method:
#   wtype:    installed
#   dotool:   installed (if available)
#   ydotool:  installed, daemon running
#   wl-copy:  installed
```

--------------------------------

### Download Cohere Transcribe Model

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Install the Cohere Transcribe model using the voxtype setup command. This will download necessary ONNX files and token data from HuggingFace.

```bash
voxtype setup model      # Pick the Cohere section, confirm the size warning
```

--------------------------------

### Start Speed of Sound Application

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/speedofsound.html

Launches the Speed of Sound GUI application. Activation for recording is then done via a configured shortcut or trigger script.

```bash
speedofsound
```

--------------------------------

### Setup Waybar Integration

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/WAYBAR.md

Run this command to generate Waybar module JSON and CSS styling for Voxtype integration.

```bash
voxtype setup waybar
```

--------------------------------

### Cancel Recording

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/smoke_tests/recording-cycle.md

Starts a recording, waits for 2 seconds, and then cancels it, ensuring no transcription occurs. This is useful for discarding unwanted audio segments. The example includes a command to verify no transcription in the system logs.

```bash
# Cancel recording (should not transcribe)
voxtype record start
sleep 2
voxtype record cancel
# Verify no transcription in logs:
journalctl --user -u voxtype --since "30 seconds ago" | grep -i transcri
```

--------------------------------

### Setup Modifier Interference Fix for Sway

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/TROUBLESHOOTING.md

Run this command to automatically install a fix for modifier key interference in Sway. It configures a mode to block modifier keys during text output. Ensure to reload the compositor and restart the voxtype service.

```bash
voxtype setup compositor sway
swaymsg reload
systemctl --user restart voxtype
```

--------------------------------

### Setup Modifier Interference Fix for Hyprland

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/TROUBLESHOOTING.md

Run this command to automatically install a fix for modifier key interference in Hyprland. It configures a submap to block modifier keys during text output. Ensure to reload the compositor and restart the voxtype service.

```bash
voxtype setup compositor hyprland
hyprctl reload
systemctl --user restart voxtype
```

--------------------------------

### Setup Modifier Interference Fix for River

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/TROUBLESHOOTING.md

Run this command to automatically install a fix for modifier key interference in River. It configures a mode to block modifier keys during text output. Restart River or source the new config, and restart the voxtype service.

```bash
voxtype setup compositor river
# Restart River or source the new config
systemctl --user restart voxtype
```

--------------------------------

### Install Voxtype with Homebrew

Source: https://github.com/peteonrails/voxtype/blob/dev/website/download/index.html

Use this command to install Voxtype if you have Homebrew installed on your macOS or Linux system.

```bash
brew install voxtype
```

--------------------------------

### Install Voxtype

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/nerd-dictation.html

Installs Voxtype using a .deb package. Download the package and then use dpkg to install it.

```bash
curl -LO https://github.com/peteonrails/voxtype/releases/download/v0.6.0/voxtype_0.6.0-1_amd64.deb
sudo dpkg -i voxtype_0.6.0-1_amd64.deb
```

--------------------------------

### Build Voxtype Menubar and Setup Applications

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/MACOS_ARCHITECTURE.md

Builds the VoxtypeMenubar and VoxtypeSetup macOS applications using their respective build scripts. Navigate to the application directory before running.

```bash
# Build VoxtypeMenubar
cd macos/VoxtypeMenubar
./build-app.sh

# Build VoxtypeSetup
cd macos/VoxtypeSetup
./build-app.sh
```

--------------------------------

### Enable and Start Voxtype Systemd Service

Source: https://github.com/peteonrails/voxtype/blob/dev/contrib/manjaro-sway/README.md

Enable the Voxtype systemd user service to start on login and start it immediately for testing.

```bash
# Start service
systemctl --user enable --now voxtype
```

--------------------------------

### Voxtype Daemon Example Session

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Illustrates a typical session with the Voxtype daemon, showing startup messages, hotkey usage, and transcription output.

```bash
$ voxtype
[INFO] Voxtype v0.1.0 starting...
[INFO] Using model: base.en
[INFO] Hotkey: SCROLLLOCK
[INFO] Output mode: type (fallback: clipboard)
[INFO] Ready! Hold SCROLLLOCK to record.

# User holds ScrollLock and says "Hello world"
[INFO] Recording started...
[INFO] Recording stopped (1.2s)
[INFO] Transcribing...
[INFO] Transcribed: "Hello world"
[INFO] Typed 11 characters
```

--------------------------------

### Test with different models

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/smoke_tests/model-switching.md

After downloading, you can test different models by editing the configuration file or using a command-line flag.

```bash
# Test with different models (edit config.toml or use --model flag)
```

--------------------------------

### Install Experimental aarch64 Voxtype Binary

Source: https://github.com/peteonrails/voxtype/blob/dev/website/news/index.html

Manually install the experimental aarch64 CPU binary for Voxtype. Ensure you have curl installed and the target directory is writable.

```bash
curl -L https://github.com/peteonrails/voxtype/releases/download/v0.7.2/voxtype-0.7.2-linux-aarch64-cpu \
  -o /usr/local/bin/voxtype
chmod 755 /usr/local/bin/voxtype
voxtype --version
```

--------------------------------

### Install wtype for Wayland

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Install wtype, the recommended tool for type mode on Wayland due to its CJK/Unicode support. Installation commands vary by Linux distribution.

```bash
# Install wtype
# Fedora: sudo dnf install wtype
# Arch: sudo pacman -S wtype
# Ubuntu: sudo apt install wtype
```

--------------------------------

### waystt Local Mode Installation and Configuration

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/waystt.html

Install the waystt-bin package, manually download a GGML model to the specified directory, and configure window manager keybinds to execute waystt with specific arguments.

```bash
paru -S waystt-bin
mkdir -p ~/.local/share/waystt
# Download GGML model manually...
# bind = $mod, D, exec, waystt --local --pipe-to "ydotool type --file -"
```

--------------------------------

### Run Quickshell Directly from Checkout

Source: https://github.com/peteonrails/voxtype/blob/dev/quickshell/README.md

Starts the Quickshell frontend directly from a repository checkout for development purposes. This command assumes the 'qs' executable is available and the 'quickshell' directory is in the current path.

```bash
qs -p quickshell
```

--------------------------------

### Install Voxtype via NixOS flake

Source: https://github.com/peteonrails/voxtype/blob/dev/website/index.html

Installs Voxtype using Nix flakes, offering imperative installation or pinning in flake inputs. Specifies available outputs for different variants.

```bash
# Imperative install
nix profile install github:peteonrails/voxtype/v0.7.5#vulkan

# Available outputs: default, vulkan, cuda, rocm, osdGtk4, osdNative
nix build github:peteonrails/voxtype/v0.7.5#osdGtk4

# Or pin in your flake inputs
inputs.voxtype.url = "github:peteonrails/voxtype/v0.7.5";
```

--------------------------------

### Example: Logging Output with Hooks

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Demonstrates using the `post_output_command` hook to log the current date and time to a file after typing.

```bash
post_output_command = "echo $(date) >> ~/voxtype.log"
```

--------------------------------

### Voxtype Configuration for Speed vs Accuracy Example

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Example configuration prioritizing a fast primary model and an accurate secondary model, with audio feedback enabled for model switching.

```toml
[hotkey]
key = "SCROLLLOCK"
model_modifier = "LEFTSHIFT"

[whisper]
model = "tiny.en"                   # Lightning fast for quick notes
secondary_model = "large-v3-turbo"  # High accuracy when needed

[audio.feedback]
enabled = true  # Helpful audio cues when switching models
```

--------------------------------

### Install VOSK for Nerd-dictation

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/nerd-dictation.html

Installs the VOSK speech recognition toolkit using pip.

```bash
pip install vosk
```

--------------------------------

### Configure On-Screen Visualizer

Source: https://github.com/peteonrails/voxtype/blob/dev/website/news/index.html

Enable and configure the on-screen microphone visualizer. This snippet shows how to enable the visualizer and set its frontend and position. The daemon automatically spawns the OSD on startup.

```toml
[osd]
enabled = true
frontend = "gtk4"          # or "native"
position = "bottom-center"
top_margin = 0.85          # swayosd-aligned by default
```

--------------------------------

### Install Build Dependencies on Fedora

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL.md

Installs necessary build dependencies for Voxtype on Fedora systems.

```bash
# Fedora:
sudo dnf install rust cargo alsa-lib-devel clang-devel cmake pkgconf
```

--------------------------------

### Start Recording via CLI

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

Starts the recording process using the voxtype CLI. This command is intended for use when built-in hotkey detection is disabled.

```bash
voxtype record start                # Start recording
```

--------------------------------

### Install Build Dependencies on Debian/Ubuntu

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL.md

Installs necessary build dependencies for Voxtype on Debian/Ubuntu systems.

```bash
# Debian/Ubuntu:
sudo apt install cargo libasound2-dev libclang-dev cmake pkg-config
```

--------------------------------

### AI Coding Assistant Example

Source: https://github.com/peteonrails/voxtype/blob/dev/website/index.html

Demonstrates interaction with an AI Coding Assistant, showing command-line input and file editing.

```bash
pete@arch:~/projects/myapp$ ai-assistant

AI Coding Assistant v1.0

Enter your prompt or type /help for commands.

You:
```

```bash
gedit - project-notes.md
```

--------------------------------

### Install Dependencies on Fedora

Source: https://github.com/peteonrails/voxtype/blob/dev/README.md

Installs the 'wtype' and 'wl-clipboard' packages on Fedora systems. These are runtime dependencies for Voxtype.

```bash
sudo dnf install wtype wl-clipboard
```

--------------------------------

### Voxtype Configuration with Profiles Example

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/CONFIGURATION.md

An example TOML configuration demonstrating default post-processing settings and multiple profiles for different use cases, including Slack, code comments, and meeting notes.

```toml
# Default post-processing
[output.post_process]
command = "ollama run llama3.2:1b 'Clean up:'"
timeout_ms = 30000

# Profile: casual chat
[profiles.slack]
post_process_command = "ollama run llama3.2:1b 'Rewrite casually for Slack:'"

# Profile: code comments, output to clipboard
[profiles.code]
post_process_command = "ollama run llama3.2:1b 'Format as code comment:'"
output_mode = "clipboard"

# Profile: meeting notes with longer timeout
[profiles.notes]
post_process_command = "ollama run llama3.2:1b 'Convert to bullet points:'"
post_process_timeout_ms = 60000
```

--------------------------------

### River Push-to-Talk Keybindings

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Configure River using `riverctl map` for starting recording and `riverctl map -release` for stopping, enabling push-to-talk. Add these to your `~/.config/river/init` file. This requires the `voxtype record start` and `voxtype record stop` commands.

```bash
# Push-to-talk (hold to record, release to transcribe)
riverctl map normal None Scroll_Lock spawn 'voxtype record start'
riverctl map -release normal None Scroll_Lock spawn 'voxtype record stop'

# With a modifier
riverctl map normal Super V spawn 'voxtype record start'
riverctl map -release normal Super V spawn 'voxtype record stop'
```

--------------------------------

### Speech Note Installation

Source: https://github.com/peteonrails/voxtype/blob/dev/website/compare/speech-note.html

Installs Speech Note using Flatpak and provides the command to run the application.

```bash
flatpak install flathub net.mkiol.SpeechNote
flatpak run net.mkiol.SpeechNote
```

--------------------------------

### Install Build Dependencies on Arch Linux

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/INSTALL.md

Installs necessary build dependencies for Voxtype on Arch Linux.

```bash
# Arch:
sudo pacman -S rustup alsa-lib clang cmake pkgconf
```

--------------------------------

### Start and Stop Voxtype Recording

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/FAQ.md

Manually test starting and stopping Voxtype recording to verify its functionality.

```bash
voxtype record start
```

```bash
voxtype record stop
```

--------------------------------

### Sway Push-to-Talk Keybindings

Source: https://github.com/peteonrails/voxtype/blob/dev/docs/USER_MANUAL.md

Configure Sway to use `bindsym` for starting recording and `bindsym --release` for stopping, enabling push-to-talk. This requires the `voxtype record start` and `voxtype record stop` commands.

```bash
# Push-to-talk
bindsym Scroll_Lock exec voxtype record start
bindsym --release Scroll_Lock exec voxtype record stop

# With a modifier
bindsym $mod+v exec voxtype record start
bindsym --release $mod+v exec voxtype record stop
```

--------------------------------

### Voxtype Version Check

Source: https://github.com/peteonrails/voxtype/blob/dev/website/news/index.html

Checks the installed version of Voxtype. This command can be used to verify the installation and is useful for debugging.

```bash
voxtype --version
```