Struct Cli 

pub struct Cli {
    pub input: Vec<PathBuf>,
    pub format: OutputFormat,
    pub mode: CountMode,
    pub output: Option<PathBuf>,
    pub display: DisplayMode,
    pub exclude_imports: bool,
    pub max_words: Option<usize>,
    pub min_words: Option<usize>,
    pub max_characters: Option<usize>,
    pub min_characters: Option<usize>,
}

Command-line arguments for the typst-count tool.

This structure defines all available options for counting words and characters in Typst documents, including input files, output formats, counting modes, and various filtering and limiting options.

Fields

input: Vec<PathBuf>

Path(s) to Typst document(s) to count.

Multiple files can be specified to get counts for each file plus totals. Path(s) to Typst document(s)

format: OutputFormat

Output format for results.

Available formats:

• human: Human-readable table format (default)
• json: JSON format for machine processing
• csv: CSV format for spreadsheet import

mode: CountMode

What to count in the documents.

• both: Count both words and characters (default)
• words: Count only words
• characters: Count only characters

output: Option<PathBuf>

Write output to a file instead of stdout.

If not specified, output is written to stdout. The file format is determined by the --format option.

display: DisplayMode

Display mode when processing multiple files.

• auto: Detailed for multiple files, simple for single file (default)
• total: Show only totals, no per-file breakdown
• quiet: Suppress labels, output only numbers
• detailed: Always show per-file breakdown

exclude_imports: bool

Exclude content from imported/included files.

By default, text from all imported and included files is counted. Use this flag to count only the main file(s) specified on the command line.

max_words: Option<usize>

Exit with error if word count exceeds this limit.

Useful for CI/CD pipelines to enforce maximum document length. Exit code will be 1 if the limit is exceeded.

min_words: Option<usize>

Exit with error if word count is below this limit.

Useful for CI/CD pipelines to enforce minimum document length. Exit code will be 1 if the count is below the limit.

max_characters: Option<usize>

Exit with error if character count exceeds this limit.

Useful for CI/CD pipelines to enforce maximum document size. Exit code will be 1 if the limit is exceeded.

min_characters: Option<usize>

Exit with error if character count is below this limit.

Useful for CI/CD pipelines to enforce minimum document size. Exit code will be 1 if the count is below the limit.

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 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.