Struct Cli 

pub struct Cli {

    pub file: Option<PathBuf>,
    pub id: Option<String>,
    pub mode: Option<Mode>,
    pub tag: Vec<String>,
    pub fail_fast: bool,
    pub list: bool,
    pub quiet: bool,
    pub json: bool,
    pub json_pretty: bool,
    pub emit_each: Option<String>,
    pub emit: Option<String>,
    pub emit_stderr: Option<String>,
    pub timeout: Option<f64>,
    pub heartbeat: HeartbeatOpts,
    pub explain: Option<Format>,
}

Fields

file: Option<PathBuf>

Rule store. Default: the nearest .ct/rules.jsonc walking upward from the current directory.

id: Option<String>

Select rules whose id matches (substring->glob->regex promoted, anchored).

mode: Option<Mode>

Pin how –id is interpreted (promotion off): literal, glob, or regex.

tag: Vec<String>

Select rules carrying any of these tags (comma-separated).

fail_fast: bool

Stop after the first enforced violation; remaining rules are reported as skipped.

list: bool

Print the selected rules (id, lanes, question, tags); run nothing.

quiet: bool

Suppress per-rule lines and the default summary.

json: bool

Emit a structured JSON result instead of text (overrides the emit templates).

json_pretty: bool

Like --json, but pretty-printed (indented).

emit_each: Option<String>

Per-rule template written to stdout. Tokens: {RESULT} {ID} {QUESTION} {CODE} {WHY} {CMD}.

emit: Option<String>

Summary template written to stdout. Tokens: {RESULT} {OK} {ERRORS} {WARNED} {PENDING} {BROKEN} {SKIPPED} {TOTAL} {REASON}.

emit_stderr: Option<String>

Summary template written to stderr (same tokens as –emit).

timeout: Option<f64>

Default per-rule bound in seconds (fractional allowed); a rule’s own timeout field overrides it. A timed-out probe is BROKEN.

heartbeat: HeartbeatOpts

explain: Option<Format>

Print agent usage docs (md or json) and exit.

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.