aigitcommit 1.9.0

A simple git commit message generator by OpenAI compaction model.
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

/*
 * Copyright (c) 2025-2026 mingcheng <mingcheng@apache.org>
 *
 * This source code is licensed under the MIT License,
 * which is located in the LICENSE file in the source tree's root directory.
 *
 * File: cli.rs
 * Author: mingcheng (mingcheng@apache.org)
 * File Created: 2025-03-03 19:31:27
 *
 * Modified By: mingcheng (mingcheng@apache.org)
 * Last Modified: 2025-03-05 00:25:24
 */

use crate::built_info;
use clap::{Parser, Subcommand};

/// Command-line interface for `aigitcommit`.
///
/// Boolean flags omit `default_value_t = false` because that is already the
/// default for `bool`. Optional positional arguments omit `required = false`
/// for the same reason. This keeps the attribute noise down and makes the
/// definition easier to scan.
#[derive(Debug, Parser)]
#[command(
    name = built_info::PKG_NAME,
    about = built_info::PKG_DESCRIPTION,
    version = built_info::PKG_VERSION,
    author = built_info::PKG_AUTHORS,
)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Option<Command>,

    /// Path to the repository directory. Defaults to the current directory.
    #[arg(default_value = ".")]
    pub repo_path: String,

    /// Enable verbose (TRACE-level) logging.
    #[arg(long, short)]
    pub verbose: bool,

    /// Verify that the configured OpenAI model is available.
    #[arg(long)]
    pub check_model: bool,

    /// Prompt to commit after generating the message.
    #[arg(long)]
    pub commit: bool,

    /// Append a `Signed-off-by` trailer to the commit message.
    #[arg(long)]
    pub signoff: bool,

    /// Accept the generated commit message without prompting.
    #[arg(long, short)]
    pub yes: bool,

    /// Copy the generated commit message to the system clipboard.
    #[arg(long)]
    pub copy_to_clipboard: bool,

    /// Print the commit message as JSON.
    #[arg(long)]
    pub json: bool,

    /// Print the commit message as plain text instead of a table.
    #[arg(long)]
    pub no_table: bool,

    /// Print the values of the OpenAI-related environment variables and exit.
    #[arg(long)]
    pub check_env: bool,

    /// Save the generated commit message to the given file.
    #[arg(long, short, default_value = "")]
    pub save: String,

    /// Bypass the local cache and always request a fresh message from the API.
    #[arg(long)]
    pub no_cache: bool,

    /// Clear the local cache for the current repository and exit.
    #[arg(long)]
    pub clear_cache: bool,
}

#[derive(Debug, Subcommand)]
pub enum Command {
    /// Install the `prepare-commit-msg` git hook into the given repository.
    #[command(name = "install-hook")]
    InstallHook {
        /// Repository directory to install the git hook into.
        #[arg(default_value = ".")]
        repo_path: String,
    },
}

#[cfg(test)]
mod tests {
    use super::*;
    use clap::CommandFactory;

    #[test]
    fn cli_definition_is_valid() {
        // Catches programmer mistakes (duplicate short flags, bad attrs)
        // at test time instead of at first user invocation.
        Cli::command().debug_assert();
    }
}