Enum Commands

pub enum Commands {
    Match(MatchArgs),
    Convert(ConvertArgs),
    DetectEncoding(DetectEncodingArgs),
    Sync(SyncArgs),
    Config(ConfigArgs),
    GenerateCompletion(GenerateCompletionArgs),
    Cache(CacheArgs),
}

Available subcommands for the SubX CLI application.

Each variant represents a specific operation that can be performed by the SubX tool, with associated argument structures that define the parameters and options for that operation.

Command Categories

Core Processing Commands

• Match - AI-powered subtitle matching and renaming
• Convert - Format conversion between subtitle standards
• Sync - Audio-subtitle synchronization and timing adjustment

Utility Commands

• DetectEncoding - Character encoding detection and conversion
• Config - Configuration management and inspection
• Cache - Cache management and dry-run inspection
• GenerateCompletion - Shell completion script generation

Examples

use subx_cli::cli::{Commands, MatchArgs};
use std::path::PathBuf;

let match_command = Commands::Match(MatchArgs {
    path: PathBuf::from("videos/"),
    dry_run: true,
    confidence: 80,
    recursive: false,
    backup: false,
    copy: false,
    move_files: false,
});

Variants

Match(MatchArgs)

AI-powered subtitle file matching and intelligent renaming.

Uses artificial intelligence to analyze video and subtitle files, matching them based on content similarity and automatically renaming subtitle files to match their corresponding videos.

Convert(ConvertArgs)

Convert subtitle files between different formats.

Supports conversion between popular subtitle formats including SRT, ASS, VTT, and others with format-specific options.

DetectEncoding(DetectEncodingArgs)

Detect and convert character encoding of subtitle files.

Automatically detects the character encoding of subtitle files and optionally converts them to UTF-8 for better compatibility.

Sync(SyncArgs)

Synchronize subtitle timing with audio tracks.

Analyzes audio content and adjusts subtitle timing to match dialogue and speech patterns in the audio track.

Config(ConfigArgs)

Manage and inspect application configuration.

Provides tools for viewing, validating, and managing SubX configuration settings from various sources.

GenerateCompletion(GenerateCompletionArgs)

Generate shell completion scripts.

Creates completion scripts for various shells (bash, zsh, fish) to enable tab completion for SubX commands and arguments.

Cache(CacheArgs)

Manage cache and inspect dry-run results.

Provides utilities for examining cached results, clearing cache data, and inspecting the effects of dry-run operations.

Trait Implementations

impl Debug for Commands

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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