Enum Commands 

pub enum Commands {
    Synthesize {
        text: String,
        output: Option<PathBuf>,
        rate: f32,
        pitch: f32,
        volume: f32,
        quality: CliQualityLevel,
        enhance: bool,
        play: bool,
        auto_detect: bool,
    },
    SynthesizeFile {
        input: PathBuf,
        output_dir: Option<PathBuf>,
        rate: f32,
        quality: CliQualityLevel,
    },
    ListVoices {
        language: Option<String>,
        detailed: bool,
    },
    VoiceInfo {
        voice_id: String,
    },
    DownloadVoice {
        voice_id: String,
        force: bool,
    },
    PreviewVoice {
        voice_id: String,
        text: Option<String>,
        output: Option<PathBuf>,
        no_play: bool,
    },
    CompareVoices {
        voice_ids: Vec<String>,
    },
    Test {
        text: String,
        play: bool,
    },
    CrossLangTest {
        format: String,
        save_report: bool,
    },
    TestApi {
        server_url: String,
        api_key: Option<String>,
        concurrent: Option<usize>,
        report: Option<String>,
        verbose: bool,
    },
    Config {
        show: bool,
        init: bool,
        path: Option<PathBuf>,
    },
    ListModels {
        backend: Option<String>,
        detailed: bool,
    },
    DownloadModel {
        model_id: String,
        force: bool,
    },
    BenchmarkModels {
        model_ids: Vec<String>,
        iterations: u32,
        accuracy: bool,
    },
    OptimizeModel {
        model_id: String,
        output: Option<String>,
        strategy: String,
    },
    Batch {
        input: PathBuf,
        output_dir: Option<PathBuf>,
        workers: Option<usize>,
        rate: f32,
        pitch: f32,
        volume: f32,
        quality: CliQualityLevel,
        resume: bool,
    },
    Server {
        port: u16,
        host: String,
    },
    Interactive {
        voice: Option<String>,
        no_audio: bool,
        debug: bool,
        load_session: Option<PathBuf>,
        auto_save: bool,
    },
    Guide {
        command: Option<String>,
        getting_started: bool,
        examples: bool,
    },
    GenerateCompletion {
        shell: Shell,
        output: Option<PathBuf>,
        install_help: bool,
        install_script: bool,
        status: bool,
    },
    Dataset {
        command: DatasetCommands,
    },
    Dashboard {
        interval: u64,
    },
    Cloud {
        command: CloudCommands,
    },
    Telemetry {
        command: TelemetryCommands,
    },
    Lsp {
        verbose: bool,
    },
    Accuracy {
        command: AccuracyCommand,
    },
    Performance {
        command: PerformanceCommand,
    },
    Emotion {
        command: EmotionCommand,
    },
    Clone {
        command: CloningCommand,
    },
    Convert {
        command: ConversionCommand,
    },
    Sing {
        command: SingingCommand,
    },
    Spatial {
        command: SpatialCommand,
    },
    Capabilities {
        command: CapabilitiesCommand,
    },
    Checkpoint {
        command: CheckpointCommands,
    },
    Monitor {
        command: MonitoringCommand,
    },
    Train {
        command: TrainCommands,
    },
    ConvertModel {
        input: PathBuf,
        output: PathBuf,
        from: Option<String>,
        model_type: String,
        verify: bool,
    },
    VocoderInfer {
        checkpoint: PathBuf,
        mel: Option<PathBuf>,
        output: PathBuf,
        steps: usize,
        quality: Option<String>,
        batch_input: Option<PathBuf>,
        batch_output: Option<PathBuf>,
        metrics: bool,
    },
    Stream {
        text: Option<String>,
        latency: u64,
        chunk_size: usize,
        buffer_chunks: usize,
        play: bool,
    },
    ModelInspect {
        model: PathBuf,
        detailed: bool,
        export: Option<PathBuf>,
        verify: bool,
    },
    Export {
        export_type: String,
        source: String,
        output: PathBuf,
        include_weights: bool,
    },
    Import {
        input: PathBuf,
        name: Option<String>,
        force: bool,
        validate: bool,
    },
    History {
        limit: usize,
        stats: bool,
        suggest: bool,
        clear: bool,
    },
    Workflow {
        command: WorkflowCommands,
    },
    Alias {
        command: AliasCommand,
    },
}

CLI commands

Variants

Synthesize

Synthesize text to speech

Fields

text: String

Text to synthesize

output: Option<PathBuf>

Output file path (use ‘-’ for stdout, omit for auto-generated filename)

rate: f32

Speaking rate (0.5 - 2.0)

pitch: f32

Pitch shift in semitones (-12.0 - 12.0)

volume: f32

Volume gain in dB (-20.0 - 20.0)

quality: CliQualityLevel

Quality level

enhance: bool

Enable audio enhancement

play: bool

Play audio after synthesis

auto_detect: bool

Auto-detect input format (SSML, Markdown, JSON, or plain text)

SynthesizeFile

Synthesize from file

Fields

input: PathBuf

Input text file

output_dir: Option<PathBuf>

Output directory

rate: f32

Speaking rate

quality: CliQualityLevel

Quality level

ListVoices

List available voices

Fields

language: Option<String>

Filter by language

detailed: bool

Show detailed information

VoiceInfo

Get voice information

Fields

voice_id: String

Voice ID

DownloadVoice

Download voice

Fields

voice_id: String

Voice ID to download

force: bool

Force download even if voice exists

PreviewVoice

Preview a voice with a sample text

Fields

voice_id: String

Voice ID to preview

text: Option<String>

Custom preview text (default: “This is a preview of this voice.”)

output: Option<PathBuf>

Save preview to file instead of just playing

no_play: bool

Skip audio playback (only save to file)

CompareVoices

Compare multiple voices side by side

Fields

voice_ids: Vec<String>

Voice IDs to compare

Test

Test synthesis pipeline

Fields

text: String

Test text

play: bool

Play audio instead of saving

CrossLangTest

Run cross-language consistency tests for FFI bindings

Fields

format: String

Output format for test report (json, yaml)

save_report: bool

Save detailed test report to file

TestApi

Test API endpoints for VoiRS server

Fields

server_url: String

Server URL (e.g., http://localhost:8080)

api_key: Option<String>

API key for authentication

concurrent: Option<usize>

Number of concurrent requests for load testing

report: Option<String>

Path to save test report (JSON or Markdown)

verbose: bool

Enable verbose output

Config

Show configuration

Fields

show: bool

Show configuration and exit

init: bool

Initialize default configuration

path: Option<PathBuf>

Configuration file path for init

ListModels

List available models

Fields

backend: Option<String>

Filter by backend

detailed: bool

Show detailed information

DownloadModel

Download a model

Fields

model_id: String

Model ID to download

force: bool

Force download even if model exists

BenchmarkModels

Benchmark models

Fields

model_ids: Vec<String>

Model IDs to benchmark

iterations: u32

Number of iterations

accuracy: bool

Include accuracy testing against CMU test set (>95% phoneme accuracy target)

OptimizeModel

Optimize model for current hardware

Fields

model_id: String

Model ID to optimize

output: Option<String>

Output path for optimized model

strategy: String

Optimization strategy (speed, quality, memory, balanced)

Batch

Batch process multiple texts

Fields

input: PathBuf

Input file or directory

output_dir: Option<PathBuf>

Output directory

workers: Option<usize>

Number of parallel workers

rate: f32

Speaking rate

pitch: f32

Pitch shift in semitones

volume: f32

Volume gain in dB

quality: CliQualityLevel

Quality level

resume: bool

Enable resume functionality

Server

Server mode (future feature)

Fields

port: u16

Port to bind to

host: String

Host to bind to

Interactive

Interactive mode for real-time synthesis

Fields

voice: Option<String>

Initial voice to use

no_audio: bool

Disable audio playback (synthesis only)

debug: bool

Enable debug output

load_session: Option<PathBuf>

Load session from file

auto_save: bool

Auto-save session changes

Guide

Show detailed help and guides

Fields

command: Option<String>

Command to get help for

getting_started: bool

Show getting started guide

examples: bool

Show examples for all commands

GenerateCompletion

Generate shell completion scripts

Fields

shell: Shell

Shell to generate completion for

output: Option<PathBuf>

Output file (default: stdout)

install_help: bool

Show installation instructions

install_script: bool

Generate installation script

status: bool

Show completion status for all shells

Dataset

Dataset management and validation commands

Fields

command: DatasetCommands

Dataset subcommand to execute

Dashboard

Real-time monitoring dashboard

Fields

interval: u64

Update interval in milliseconds

Cloud

Cloud integration commands

Fields

command: CloudCommands

Cloud subcommand to execute

Telemetry

Telemetry management commands

Fields

command: TelemetryCommands

Telemetry subcommand to execute

Lsp

Start Language Server Protocol (LSP) server for editor integrations

Fields

verbose: bool

Enable verbose logging

Accuracy

Accuracy benchmarking commands

Fields

command: AccuracyCommand

Accuracy command configuration

Performance

Performance targets testing and monitoring

Fields

command: PerformanceCommand

Performance command configuration

Emotion

Emotion control commands

Fields

command: EmotionCommand

Emotion subcommand to execute

Clone

Voice cloning commands

Fields

command: CloningCommand

Cloning subcommand to execute

Convert

Voice conversion commands

Fields

command: ConversionCommand

Conversion subcommand to execute

Sing

Singing voice synthesis commands

Fields

command: SingingCommand

Singing subcommand to execute

Spatial

3D spatial audio commands

Fields

command: SpatialCommand

Spatial subcommand to execute

Capabilities

Feature detection and capability reporting

Fields

command: CapabilitiesCommand

Capabilities subcommand to execute

Checkpoint

Checkpoint management commands

Fields

command: CheckpointCommands

Checkpoint subcommand to execute

Monitor

Advanced monitoring and debugging commands

Fields

command: MonitoringCommand

Monitoring subcommand to execute

Train

Train models (vocoder, acoustic, g2p)

Fields

command: TrainCommands

Training subcommand to execute

ConvertModel

Convert model formats (ONNX, PyTorch → SafeTensors)

Fields

input: PathBuf

Input model path

output: PathBuf

Output path (SafeTensors format)

from: Option<String>

Source format (auto-detect if not specified)

model_type: String

Model type (vocoder, acoustic, g2p)

verify: bool

Verify conversion by running test inference

VocoderInfer

Run vocoder inference (mel → audio)

Fields

checkpoint: PathBuf

Path to vocoder checkpoint (SafeTensors)

mel: Option<PathBuf>

Path to mel spectrogram file (optional, generates dummy if omitted)

output: PathBuf

Output audio file path

steps: usize

Number of diffusion sampling steps

quality: Option<String>

Quality preset (fast, balanced, high)

batch_input: Option<PathBuf>

Batch processing: input directory

batch_output: Option<PathBuf>

Batch processing: output directory

metrics: bool

Show performance metrics

Stream

Stream real-time text-to-speech synthesis

Fields

text: Option<String>

Initial text to synthesize

latency: u64

Target latency in milliseconds

chunk_size: usize

Chunk size in frames

buffer_chunks: usize

Buffer size in chunks

play: bool

Enable audio output

ModelInspect

Inspect and analyze model files

Fields

model: PathBuf

Model file path

detailed: bool

Show detailed layer information

export: Option<PathBuf>

Export architecture to file

verify: bool

Verify model integrity

Export

Export voice profile or preset

Fields

export_type: String

Export type (voice-profile, emotion-preset, config)

source: String

Source identifier (voice ID, preset name, etc.)

output: PathBuf

Output file path

include_weights: bool

Include model weights

Import

Import voice profile or preset

Fields

input: PathBuf

Import file path

name: Option<String>

Installation name/identifier

force: bool

Force overwrite if exists

validate: bool

Validate before importing

History

View command history and get suggestions

Fields

limit: usize

Number of recent commands to show

stats: bool

Show usage statistics

suggest: bool

Show command suggestions based on history

clear: bool

Clear all history

Workflow

Workflow automation commands

Fields

command: WorkflowCommands

Workflow subcommand to execute

Alias

Manage command aliases

Fields

command: AliasCommand

Alias subcommand

Trait Implementations

impl FromArgMatches for Commands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Commands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand