Struct Cli 

#[non_exhaustive]
pub struct Cli {

    pub format_in: Option<String>,
    pub items: Option<String>,
    pub columns: Option<Vec<String>>,
    pub score: Option<String>,
    pub scale: Option<f64>,
    pub invert: bool,
    pub preset: Option<String>,
    pub by: Option<Vec<String>>,
    pub strategy: Option<String>,
    pub bands: Option<u8>,
    pub top: Option<u32>,
    pub within: Vec<String>,
    pub cluster: Vec<String>,
    pub page: Option<u32>,
    pub per_page: Option<u32>,
    pub format: Option<OutputFormat>,
    pub json: bool,
    pub color: Option<String>,
    pub explain: bool,
    pub schema: bool,
    pub interactive: bool,
    pub verbose: bool,
}

Parsed CLI surface for the face binary.

Each flag is documented inline; see docs/design.md §3 for the authoritative table. The shape is derive-style clap so we can generate --help from the doc comments and rebind without a custom builder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format_in: Option<String>

Force input format (skip sniffing). One of: json, jsonl, csv, tsv.

items: Option<String>

jq-like path to the items array within the input document.

columns: Option<Vec<String>>

Comma-separated column names for headerless CSV.

score: Option<String>

jq-like path to the score field on each item.

scale: Option<f64>

Optional max scale used to normalize raw score values for --invert.

invert: bool

Flip score polarity (lower-is-better → higher-is-better).

preset: Option<String>

Named preset (confidence, concept-search, bm25, severity, or user-defined).

by: Option<Vec<String>>

Field(s) to group by; comma chains nested axes (e.g. file,module).

strategy: Option<String>

Force a strategy: exact, prefix, top, bands, quantiles, natural, similar. Optional payload: top=10, bands=5, prefix=2, similar=token.

bands: Option<u8>

Number of bands for bands strategy (default 5).

top: Option<u32>

Number of clusters for top strategy.

within: Vec<String>

Add a sub-axis. Repeatable — each --within adds a level of nesting.

cluster: Vec<String>

Drill into a specific cluster. Accepts a 1-based top-level ordinal (1), canonical comma form (file:src/cli.rs,score:excellent), or axis=value (repeatable).

page: Option<u32>

Page number (1-based).

per_page: Option<u32>

Items per page.

format: Option<OutputFormat>

Output format: human (default), json, json-flat, jsonl-items, tsv, csv, markdown.

json: bool

Shortcut for --format=json.

color: Option<String>

Color policy: auto (default), always, never.

explain: bool

Print full detection reasoning, then exit.

schema: bool

Print input shape, then exit.

interactive: bool

Drill through clusters with an inline picker when attached to a TTY.

verbose: bool

Emit provenance line and skip warnings on stderr.

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.