t-rec 0.8.2

Blazingly fast terminal recorder that generates animated gif images for the web written in rust.
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
117
118
119
120
121
122
123
124
125
126

//! Parse command line arguments.
//!
//! # Why no `default_value` on CliArgs?
//!
//! You might be tempted to use clap's `default_value` or `default_value_t` attributes. **Don't!**
//!
//! The problem: clap applies defaults *before* we can check if the user actually provided a value.
//! This breaks our config precedence model where config/profile values should override CLI defaults,
//! but explicit CLI args should override config.
//!
//! Example of what goes wrong with `default_value`:
//! - Config file has `fps = 10`
//! - User runs `t-rec` (no `--fps` flag)
//! - With `default_value_t = 4`: clap sets `fps = 4`, we can't tell user didn't specify it,
//!   config's `fps = 10` is ignored
//! - With `Option<u8>` (no default): clap sets `fps = None`, we know to use config's `fps = 10`
//!
//! By using `Option<T>` without defaults, `None` clearly means "user didn't specify, use config
//! or fall back to default". The actual defaults are applied later in `ProfileSettings` accessor
//! methods, after config merging.
//!
//! Note: The default values shown in help text (e.g., `[default: 4]`) must be kept in sync with
//! the constants in `config::defaults` module. This duplication is unfortunate but necessary
//! because Rust's `concat!` macro only works with literal strings, not const references.

use clap::Parser;

use crate::config::{resolve_settings, ProfileSettings};

/// Blazingly fast terminal recorder that generates animated gif images for the web
#[derive(Parser, Debug)]
#[command(author, version, about)]
pub struct CliArgs {
    /// Enable verbose insights for the curious
    #[arg(short, long)]
    pub verbose: bool,

    /// Quiet mode, suppresses the banner: 'Press Ctrl+D to end recording'
    #[arg(short, long)]
    pub quiet: bool,

    /// Generates additionally to the gif a mp4 video of the recording
    #[arg(short = 'm', long)]
    pub video: bool,

    /// Generates only a mp4 video and not gif
    #[arg(short = 'M', long = "video-only", conflicts_with = "video")]
    pub video_only: bool,

    /// Decorates the animation with certain, mostly border effects [default: none]
    #[arg(short, long, value_parser = ["shadow", "none"])]
    pub decor: Option<String>,

    /// Wallpaper background. Use 'ventura' for built-in, or provide a path to a custom image (PNG, JPEG, TGA)
    #[arg(short = 'p', long)]
    pub wallpaper: Option<String>,

    /// Padding in pixels around the recording when using --wallpaper [default: 60]
    #[arg(long = "wallpaper-padding", value_parser = clap::value_parser!(u32).range(1..=500))]
    pub wallpaper_padding: Option<u32>,

    /// Background color when decors are used [default: transparent]
    #[arg(short, long, value_parser = ["white", "black", "transparent"])]
    pub bg: Option<String>,

    /// If you want a very natural typing experience and disable the idle detection and sampling optimization
    #[arg(short, long = "natural")]
    pub natural: bool,

    /// If you want to see a list of windows available for recording by their id
    #[arg(short = 'l', long = "ls-win", visible_alias = "ls")]
    pub list_windows: bool,

    /// Window Id (see --ls-win) that should be captured, instead of the current terminal
    #[arg(short = 'w', long = "win-id")]
    pub win_id: Option<u64>,

    /// Pause time at the end of the animation (e.g., "2s", "500ms")
    #[arg(short = 'e', long = "end-pause")]
    pub end_pause: Option<String>,

    /// Pause time at the start of the animation (e.g., "1s", "200ms")
    #[arg(short = 's', long = "start-pause")]
    pub start_pause: Option<String>,

    /// Max idle time before optimization kicks in. Can enhance readability [default: 3s]
    #[arg(short = 'i', long = "idle-pause")]
    pub idle_pause: Option<String>,

    /// Output file without extension [default: t-rec]
    #[arg(short = 'o', long = "output")]
    pub output: Option<String>,

    /// Capture framerate, 4-15 fps. Higher = smoother but larger files [default: 4]
    #[arg(short = 'f', long, value_parser = clap::value_parser!(u8).range(4..=15))]
    pub fps: Option<u8>,

    /// Shell or program to launch. Defaults to $SHELL
    #[arg()]
    pub program: Option<String>,

    // --- Config-related args (not part of recording settings) ---
    /// Use a named profile from the config file
    #[arg(long)]
    pub profile: Option<String>,

    /// Create a starter config file at `~/.config/t-rec/config.toml` (linux) or `~/Library/Application Support/t-rec/config.toml` (macOS)
    #[arg(long = "init-config")]
    pub init_config: bool,

    /// List available profiles from the config file
    #[arg(long = "list-profiles")]
    pub list_profiles: bool,
}

pub fn launch() -> CliArgs {
    CliArgs::parse()
}

/// Load config and resolve settings: config defaults -> profile -> CLI args
pub fn resolve_profiled_settings(args: &CliArgs) -> anyhow::Result<ProfileSettings> {
    let config = crate::config::load_config()?;
    let profile_name = args.profile.as_deref();

    resolve_settings(config.as_ref(), profile_name, args)
}