Skip to content

CLI Reference

Voicepad's command-line interface provides easy access to recording, transcription, and configuration management.

Command Structure

voicepad [COMMAND] [SUBCOMMAND] [OPTIONS]

Available commands:

  • record - Audio recording and management
  • config - Configuration and system information

Global Options

--help, -h        # Show help and exit
--version         # Show version and exit

Commands

Recording Commands

voicepad record - Manage audio recordings

Complete recording reference →

Configuration Commands

voicepad config - View and manage configuration

Complete configuration reference →

Common Usage Patterns

Quick Recording

# Basic recording (press Ctrl+C to stop)
voicepad record start

# With custom filename
voicepad record start --prefix meeting_notes

# Fixed duration
voicepad record start --duration 300

Long Recording with VAD

# Enable smart chunking for real-time transcription
voicepad record start --vad --min-chunk-duration 60

# Adjust sensitivity
voicepad record start --vad --vad-threshold 0.45

Configuration Check

# Check current setup
voicepad record info
voicepad config transcription

# Get recommendations
voicepad config recommend
voicepad config system

Exit Codes

  • 0 - Success
  • 1 - General error
  • 2 - Invalid configuration
  • 130 - Interrupted by user (Ctrl+C - expected during recording)

Environment Variables

Override configuration using VOICEPAD_* environment variables:

# Override transcription model
export VOICEPAD_TRANSCRIPTION_MODEL=tiny

# Run with override
voicepad record start

See Configuration Guide for details.

Next Steps