Struct Cli 

pub struct Cli {

    pub base: PathBuf,
    pub name: Option<String>,
    pub hidden: bool,
    pub follow: bool,
    pub no_ignore: bool,
    pub validate: bool,
    pub list: bool,
    pub show: Option<PathBuf>,
    pub links: bool,
    pub new: Option<PathBuf>,
    pub init: bool,
    pub index: bool,
    pub log: Option<String>,
    pub set: Option<String>,
    pub script: Option<PathBuf>,
    pub dry_run: bool,
    pub fence: Option<String>,
    pub type_: Option<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub tag: Vec<String>,
    pub log_kind: Option<String>,
    pub file: Option<PathBuf>,
    pub strict: bool,
    pub question: Option<String>,
    pub expect: Option<String>,
    pub emit: Option<String>,
    pub emit_stderr: Option<String>,
    pub quiet: bool,
    pub json: bool,
    pub json_pretty: bool,
    pub timeout: Option<f64>,
    pub heartbeat: HeartbeatOpts,
    pub explain: Option<Format>,
}

Fields

base: PathBuf

Bundle root (or single concept root) to operate on.

name: Option<String>

Limit selection to files whose name matches; ‘|’-separated alternatives, each substring->glob->regex promoted and anchored.

hidden: bool

Include dot-entries (names starting with ‘.’); default skips them.

follow: bool

Follow symlinks while traversing.

no_ignore: bool

Walk gitignored / .ignore files too (the .git directory is always skipped); by default the walk skips what git would.

validate: bool

Check the bundle for OKF conformance and report a verdict (the default verb when no other is given).

list: bool

List the bundle’s concepts with their metadata; filter with –type / –tag.

show: Option<PathBuf>

Show one concept’s frontmatter (give the concept path).

links: bool

Report the bundle’s cross-links; with –strict, fail on a broken bundle-relative link.

new: Option<PathBuf>

Scaffold a new concept at PATH (requires –type); refuses to overwrite.

init: bool

Scaffold a bundle root index.md (declaring okf_version) if absent.

index: bool

(Re)generate index.md for –base from the concepts’ frontmatter.

log: Option<String>

Prepend a dated entry to the bundle’s log.md (use –log-kind to label it).

set: Option<String>

Set or update a frontmatter field on the –file concept: FIELD=VALUE.

script: Option<PathBuf>

Run a .ctb script of new/set/log/index/init items atomically: simulate the whole batch, write only if every op succeeds.

dry_run: bool

With –script: simulate and print the plan, but write nothing.

fence: Option<String>

With –script: the directive prefix for script lines (default “#%”).

type_: Option<String>

The concept type for –new; also filters –list to this type.

title: Option<String>

With –new: the concept title.

description: Option<String>

With –new: the concept description (one sentence).

tag: Vec<String>

With –new: tags (comma-separated); also filters –list to concepts carrying all given tags.

log_kind: Option<String>

With –log: the entry label (e.g. Update, Creation). Default: Update.

file: Option<PathBuf>

With –set: the concept file to edit.

strict: bool

With –validate / –links: also treat broken bundle-relative links as failures.

question: Option<String>

Question this check answers, framing it as a test; printed as a “== … ==” banner unless –quiet.

expect: Option<String>

Verdict expectation over the violation count: any|none|N|=N|+N|-N. Default: none (every concept conforms / no broken links).

emit: Option<String>

Template written to stdout after a check. Tokens: {RESULT} {QUESTION} {COUNT} {TOTAL} {BASE} {MATCHES} ({COUNT} is the violation count).

emit_stderr: Option<String>

Template written to stderr after a check (same tokens as –emit).

quiet: bool

Suppress informational output; report via exit status (and –emit, which still fires).

json: bool

Emit a structured JSON result instead of text.

json_pretty: bool

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

timeout: Option<f64>

Abort with exit 2 if the run exceeds SECS seconds (fractional allowed).

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.