subx-cli 1.7.1

AI subtitle processing CLI tool, which automatically matches, renames, and converts subtitle files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Cache management command-line arguments and operations.
//!
//! This module defines the command-line interface for cache-related operations
//! in SubX. The cache system stores intermediate results from AI analysis and
//! other computationally expensive operations to improve performance and reduce
//! API costs during development and testing.
//!
//! # Cache System Overview
//!
//! SubX maintains several types of caches:
//! - **AI Analysis Cache**: Results from AI-powered file matching
//! - **Audio Analysis Cache**: Speech pattern detection results
//! - **Configuration Cache**: Processed configuration data
//! - **Dry-run Cache**: Preview results that can be applied later
//!
//! # Cache Benefits
//!
//! - **Performance**: Avoid re-analyzing the same content
//! - **Cost Savings**: Reduce AI API calls during testing
//! - **Development**: Faster iteration during debugging
//! - **Reliability**: Consistent results across multiple runs
//!
//! # Examples
//!
//! ```bash
//! # Clear all cache data
//! subx cache clear
//!
//! # View cache status (future enhancement)
//! subx cache status
//!
//! # Selective cache clearing (future enhancement)
//! subx cache clear --type ai
//! ```

use clap::{Args, Subcommand, ValueEnum};

/// Command-line arguments for cache management operations.
#[derive(Args, Debug)]
pub struct CacheArgs {
    /// The cache management action to perform
    #[command(subcommand)]
    pub action: CacheAction,
}

/// Cache management operations and subcommands.
#[derive(Subcommand, Debug)]
pub enum CacheAction {
    /// Display cache status including size, age, and validity
    Status(StatusArgs),
    /// Apply cached dry-run results without calling the AI provider
    Apply(ApplyArgs),
    /// Undo the most recent batch of file operations
    Rollback(RollbackArgs),
    /// Clear cached data
    Clear(ClearArgs),
}

/// Arguments for the `cache status` subcommand.
#[derive(Args, Debug)]
pub struct StatusArgs {
    /// Output status in JSON format for scripting.
    ///
    /// **Backward-compatible alias** for the global `--output json`
    /// flag (see [`crate::cli::OutputMode`]). When this flag is set,
    /// the command behaves exactly as if the user had invoked
    /// `subx-cli --output json cache status`: the same JSON envelope
    /// is rendered through [`crate::cli::output::emit_success`] and the
    /// stdout bytes are guaranteed to be byte-identical between the
    /// two invocations. Per the `cache-management` spec this alias is
    /// limited to `cache status`; no other cache subcommand exposes a
    /// `--json` flag.
    #[arg(long)]
    pub json: bool,
}

/// Arguments for the `cache apply` subcommand.
#[derive(Args, Debug)]
pub struct ApplyArgs {
    /// Skip interactive confirmation prompt
    #[arg(long)]
    pub yes: bool,
    /// Bypass staleness and validation checks
    #[arg(long)]
    pub force: bool,
    /// Minimum confidence threshold (0-100) to filter operations
    #[arg(long, value_parser = clap::value_parser!(u8).range(0..=100))]
    pub confidence: Option<u8>,
}

/// Arguments for the `cache rollback` subcommand.
#[derive(Args, Debug)]
pub struct RollbackArgs {
    /// Bypass integrity verification checks
    #[arg(long)]
    pub force: bool,
}

/// Arguments for the `cache clear` subcommand.
#[derive(Args, Debug)]
pub struct ClearArgs {
    /// Type of data to clear
    #[arg(long, value_enum, default_value_t = ClearType::All)]
    pub r#type: ClearType,
}

/// Types of cache data that can be cleared.
#[derive(ValueEnum, Debug, Clone, Copy, PartialEq, Eq)]
pub enum ClearType {
    /// Clear only the match cache file
    Cache,
    /// Clear only the operation journal
    Journal,
    /// Clear both cache and journal
    All,
}