Struct Spec 

#[non_exhaustive]
pub struct Spec {

    pub name: String,
    pub bin: String,
    pub cmd: SpecCommand,
    pub config: SpecConfig,
    pub version: Option<String>,
    pub usage: String,
    pub complete: IndexMap<String, SpecComplete>,
    pub source_code_link_template: Option<String>,
    pub repository: Option<String>,
    pub author: Option<String>,
    pub about: Option<String>,
    pub about_long: Option<String>,
    pub about_md: Option<String>,
    pub license: Option<String>,
    pub before_help: Option<String>,
    pub after_help: Option<String>,
    pub before_help_long: Option<String>,
    pub after_help_long: Option<String>,
    pub disable_help: Option<bool>,
    pub min_usage_version: Option<String>,
    pub examples: Vec<SpecExample>,
    pub default_subcommand: Option<String>,
}

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.

name: String

bin: String

cmd: SpecCommand

config: SpecConfig

version: Option<String>

usage: String

complete: IndexMap<String, SpecComplete>

source_code_link_template: Option<String>

repository: Option<String>

Where the CLI’s source lives, e.g. https://github.com/jdx/mise.

Distinct from Self::source_code_link_template, which is a per-command deep link with a {{path}} placeholder and is only usable for building “view source” links in generated docs. Scraping a repository out of it works for one forge and one URL layout and fails everywhere else.

author: Option<String>

about: Option<String>

about_long: Option<String>

about_md: Option<String>

license: Option<String>

before_help: Option<String>

after_help: Option<String>

before_help_long: Option<String>

after_help_long: Option<String>

disable_help: Option<bool>

min_usage_version: Option<String>

examples: Vec<SpecExample>

default_subcommand: Option<String>

Default subcommand to use when first non-flag argument is not a known subcommand. This enables “naked” command syntax like mise foo instead of mise run foo.

Implementations

impl Spec

pub fn parse_file(file: &Path) -> Result<Spec, UsageErr>

Parse a spec from a file.

Automatically detects whether the file is:

• A .kdl or .usage.kdl file containing a raw spec
• A script file with embedded # USAGE: comments

If bin is not specified in the spec, it defaults to the filename.

pub fn parse_script(file: &Path) -> Result<Spec, UsageErr>

Parse a spec from a script file’s embedded USAGE comments.

Extracts the spec from comment lines starting with # USAGE: or // USAGE:. If bin is not specified in the spec, it defaults to the filename.

pub fn parse_spec(input: &str) -> Result<Spec, UsageErr>

👎Deprecated

pub fn is_empty(&self) -> bool

pub fn merge(&mut self, other: Spec)

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Spec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Spec

fn default() -> Spec

Returns the “default value” for a type.

impl Display for Spec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromStr for Spec

type Err = UsageErr

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for Spec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.