Enum AuditCommand 

pub enum AuditCommand {
    Audit {

        workspace: PathBuf,
        docs: PathBuf,
        crate_name: Option<String>,
        crate_path: Option<PathBuf>,
        format: CliOutputFormat,
        severity: CliSeverity,
        fail_on_critical: bool,
        exclude_files: Vec<String>,
        exclude_crates: Vec<String>,
        output: Option<PathBuf>,
        no_fail: bool,
        max_issues: usize,
        ci_mode: bool,
    
},
    Crate {
        crate_name: String,
        workspace: PathBuf,
        format: CliOutputFormat,
        severity: CliSeverity,
        fail_on_critical: bool,
        output: Option<PathBuf>,
    },
    Incremental {
        workspace: PathBuf,
        docs: PathBuf,
        changed_files: Vec<PathBuf>,
        format: CliOutputFormat,
    },
    Validate {
        file_path: PathBuf,
        workspace: PathBuf,
        format: CliOutputFormat,
    },
    Init {
        config_path: PathBuf,
        workspace: PathBuf,
        docs: PathBuf,
    },
    Stats {
        workspace: PathBuf,
        limit: usize,
    },
}

Available on crate feature doc-audit only.

Available audit commands.

Variants

Audit

Run a full documentation audit

Fields

workspace: PathBuf

Path to workspace root

docs: PathBuf

Path to documentation directory

crate_name: Option<String>

Audit only a specific crate (by name)

crate_path: Option<PathBuf>

Audit only a specific crate (by path)

format: CliOutputFormat

Output format

severity: CliSeverity

Minimum severity to report

fail_on_critical: bool

Fail build on critical issues

exclude_files: Vec<String>

Files to exclude (glob patterns)

exclude_crates: Vec<String>

Crates to exclude

output: Option<PathBuf>

Output file path (for JSON/Markdown formats)

no_fail: bool

Exit with code 0 even if issues are found (for CI/CD flexibility)

max_issues: usize

Maximum number of issues to report (0 = unlimited)

ci_mode: bool

CI/CD mode: optimized output for build systems

Crate

Audit a single crate’s documentation

Fields

crate_name: String

Name of the crate to audit (e.g., “core” for adk-core)

workspace: PathBuf

Path to workspace root

format: CliOutputFormat

Output format

severity: CliSeverity

Minimum severity to report

fail_on_critical: bool

Fail build on critical issues

output: Option<PathBuf>

Output file path (for JSON/Markdown formats)

Incremental

Run incremental audit on changed files

Fields

workspace: PathBuf

Path to workspace root

docs: PathBuf

Path to documentation directory

changed_files: Vec<PathBuf>

Changed files to audit

format: CliOutputFormat

Output format

Validate

Validate a single documentation file

Fields

file_path: PathBuf

Path to the file to validate

workspace: PathBuf

Path to workspace root (for context)

format: CliOutputFormat

Output format

Init

Initialize audit configuration

Fields

config_path: PathBuf

Path to create configuration file

workspace: PathBuf

Path to workspace root

docs: PathBuf

Path to documentation directory

Stats

Show audit statistics and history

Fields

workspace: PathBuf

Path to workspace root

limit: usize

Number of recent audit runs to show

Trait Implementations

impl FromArgMatches for AuditCommand

fn from_arg_matches( __clap_arg_matches: &ArgMatches, ) -> Result<AuditCommand, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<AuditCommand, 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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for AuditCommand

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

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

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

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

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand