Struct Cli 

pub struct Cli {

    pub path: PathBuf,
    pub target_path: Option<PathBuf>,
    pub nofetch: bool,
    pub nonormalize: bool,
    pub nocache: bool,
    pub allowshallow: bool,
    pub output: Vec<OutputFormat>,
    pub output_file: Option<PathBuf>,
    pub show_variable: Option<String>,
    pub format: Option<String>,
    pub config: Option<PathBuf>,
    pub show_config: bool,
    pub override_config: Vec<String>,
    pub branch: Option<String>,
    pub lang: Option<String>,
    pub verbosity: Verbosity,
    pub log_file: Option<PathBuf>,
    pub diag: bool,
    pub update_assembly_info: Option<Vec<String>>,
    pub ensure_assembly_info: bool,
    pub update_project_files: Option<Vec<String>>,
    pub update_wix_version_file: bool,
    pub update_package_files: Option<Vec<String>>,
    pub url: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub commit: Option<String>,
    pub dynamic_repo_location: Option<PathBuf>,
    pub exec: Option<String>,
    pub exec_version: Option<String>,
    pub dry_run: bool,
    pub tui: bool,
}

Fields

path: PathBuf

Repository path (directory containing .git). Defaults to the current directory.

target_path: Option<PathBuf>

Same as path but position-independent (upstream /targetpath).

nofetch: bool

Disable fetch (no-op: this port does not fetch).

nonormalize: bool

Disable normalization (no-op).

nocache: bool

Disable disk cache read/write (<.git>/gitversion_cache).

allowshallow: bool

Allow shallow clone (no-op: gix reads shallow repos too).

output: Vec<OutputFormat>

Output format (json, dot-env, build-server). May be repeated.

output_file: Option<PathBuf>

Output file path (writes the result to a file when set).

show_variable: Option<String>

Print a single variable only (e.g. -v SemVer).

format: Option<String>

Print using a format string (e.g. –format “{Major}.{Minor}”).

config: Option<PathBuf>

Config file path.

show_config: bool

Print the effective config as YAML and exit.

override_config: Vec<String>

Inline config override (key=value). May be repeated.

branch: Option<String>

Branch to compute for (instead of the current checkout).

lang: Option<String>

Output language (ko/en/ja/zh). Falls back to LANG/LC_ALL when omitted.

verbosity: Verbosity

Log verbosity.

log_file: Option<PathBuf>

Write log output to a file (upstream /l), or console for stderr. Logs append; stdout stays clean.

diag: bool

Diagnostic mode (Trace logging).

update_assembly_info: Option<Vec<String>>

Update AssemblyInfo files (recursive search when no file is given).

ensure_assembly_info: bool

Create the AssemblyInfo file if missing (with updateassemblyinfo).

update_project_files: Option<Vec<String>>

Update version elements in project files (.csproj etc.; recursive when no file is given).

update_wix_version_file: bool

Create GitVersion_WixVersion.wxi.

update_package_files: Option<Vec<String>>

Update the version in package manifests (package.json/Cargo.toml/pyproject.toml). Recursive search when no file is given.

url: Option<String>

Remote git repository URL (clone then compute when set). Requires --branch.

username: Option<String>

Remote auth username (with --url).

password: Option<String>

Remote auth password (with --url).

commit: Option<String>

Commit ID to inspect (latest on the branch when omitted). With --url.

dynamic_repo_location: Option<PathBuf>

Dynamic clone location (default: a temp directory).

exec: Option<String>

prepare command to run after computing (version variables exposed as GitVersion_* env and {Var}).

exec_version: Option<String>

Version-modifying command. Its stdout is applied as next-version and recomputed.

dry_run: bool

Print exec hooks without actually running them.

tui: bool

Launch the interactive Ratatui TUI.

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cli

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.