gfold 2026.3.0

CLI tool to help keep track of your Git repositories.
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

//! This module contains the CLI options for gfold.

use std::path::PathBuf;

use clap::Parser;
use clap_verbosity_flag::{InfoLevel, Verbosity};

use crate::config::{ColorMode, DisplayMode};

const HELP: &str = "\
More information: https://github.com/nickgerace/gfold

Description: this application helps you keep track of multiple Git repositories via CLI. By default, it displays relevant information for all repos in the current working directory.

Config file usage: while CLI options are prioritized, default options will fallback to the config file if it exists. Here are the config file lookup locations:

    $XDG_CONFIG_HOME/gfold.toml
    $XDG_CONFIG_HOME/gfold/config.toml
    $HOME/.config/gfold.toml (or {{FOLDERID_Profile}}\\.config\\gfold.toml on Windows)";

/// The CLI options for gfold.
#[derive(Debug, Parser)]
#[command(version, about = HELP, long_about = None)]
pub struct Cli {
    /// Specify path(s) to target directories (defaults to current working directory)
    pub paths: Option<Vec<PathBuf>>,
    /// Configure the color settings
    #[arg(short, long)]
    pub color_mode: Option<ColorMode>,
    /// Configure how collected information is displayed
    #[arg(short, long)]
    pub display_mode: Option<DisplayMode>,
    /// Display finalized config options and exit (merged options from an optional config file and command line arguments)
    #[arg(long)]
    pub dry_run: bool,
    /// Generate a man page for gfold
    #[arg(long)]
    pub generate_man: bool,
    /// Ignore config file settings
    #[arg(short, long)]
    pub ignore_config_file: bool,
    /// Specify verbosity levels for runtime execution
    #[command(flatten)]
    pub verbose: Verbosity<InfoLevel>,
}