Struct CompleteOptions 

pub struct CompleteOptions {
    pub usage_bin: String,
    pub shell: String,
    pub bin: String,
    pub cache_key: Option<String>,
    pub spec: Option<Spec>,
    pub usage_cmd: Option<String>,
    pub include_bash_completion_lib: bool,
    pub source_file: Option<String>,
}

Options for generating shell completion scripts.

Fields

usage_bin: String

Path to the usage binary (e.g., “usage” or “/usr/local/bin/usage”).

shell: String

Target shell: “bash”, “fish”, “zsh”, or “powershell”.

bin: String

Name of the CLI binary to generate completions for.

cache_key: Option<String>

Optional cache key (e.g., version) to avoid regenerating the spec file.

spec: Option<Spec>

The usage spec to embed directly in the completion script.

usage_cmd: Option<String>

Command to run to generate the usage spec dynamically.

include_bash_completion_lib: bool

Whether to include the bash-completion library sourcing (bash only).

source_file: Option<String>

Source file path for the @generated comment.