Struct SpecCommand 

pub struct SpecCommand {

    pub full_cmd: Vec<String>,
    pub usage: String,
    pub subcommands: IndexMap<String, SpecCommand>,
    pub args: Vec<SpecArg>,
    pub flags: Vec<SpecFlag>,
    pub mounts: Vec<SpecMount>,
    pub deprecated: Option<String>,
    pub hide: bool,
    pub subcommand_required: bool,
    pub restart_token: Option<String>,
    pub help: Option<String>,
    pub help_long: Option<String>,
    pub help_md: Option<String>,
    pub name: String,
    pub aliases: Vec<String>,
    pub hidden_aliases: Vec<String>,
    pub before_help: Option<String>,
    pub before_help_long: Option<String>,
    pub before_help_md: Option<String>,
    pub after_help: Option<String>,
    pub after_help_long: Option<String>,
    pub after_help_md: Option<String>,
    pub examples: Vec<SpecExample>,
    pub complete: IndexMap<String, SpecComplete>,
    /* private fields */
}

A CLI command or subcommand specification.

Commands define the structure of a CLI, including their flags, arguments, and nested subcommands. The root command represents the main CLI entry point.

Example

use usage::{SpecCommand, SpecFlag, SpecArg};

let cmd = SpecCommand::builder()
    .name("install")
    .help("Install a package")
    .alias("i")
    .flag(SpecFlag::builder().short('f').long("force").build())
    .arg(SpecArg::builder().name("package").required(true).build())
    .build();

Fields

full_cmd: Vec<String>

Full command path from root (e.g., [“git”, “remote”, “add”])

usage: String

Generated usage string

subcommands: IndexMap<String, SpecCommand>

Nested subcommands indexed by name

args: Vec<SpecArg>

Positional arguments for this command

flags: Vec<SpecFlag>

Flags/options for this command

mounts: Vec<SpecMount>

Mounted external specs

deprecated: Option<String>

Deprecation message if this command is deprecated

hide: bool

Whether to hide this command from help output

subcommand_required: bool

Whether a subcommand must be provided

restart_token: Option<String>

Token that resets argument parsing, allowing multiple command invocations. e.g., mise run lint ::: test ::: check with restart_token=“:::”

help: Option<String>

Short help text shown in command listings

help_long: Option<String>

Extended help text shown with –help

help_md: Option<String>

Markdown-formatted help text

name: String

Command name (e.g., “install”)

aliases: Vec<String>

Alternative names for this command

hidden_aliases: Vec<String>

Hidden alternative names (not shown in help)

before_help: Option<String>

Text displayed before the help content

before_help_long: Option<String>

Extended text displayed before help content

before_help_md: Option<String>

Markdown text displayed before help content

after_help: Option<String>

Text displayed after the help content

after_help_long: Option<String>

Extended text displayed after help content

after_help_md: Option<String>

Markdown text displayed after help content

examples: Vec<SpecExample>

Usage examples for this command

complete: IndexMap<String, SpecComplete>

Custom completers for arguments

Implementations

impl SpecCommand

pub fn builder() -> SpecCommandBuilder

Create a new builder for SpecCommand

pub fn usage(&self) -> String

pub fn all_subcommands(&self) -> Vec<&SpecCommand>

pub fn find_subcommand(&self, name: &str) -> Option<&SpecCommand>

Trait Implementations

impl Clone for SpecCommand

fn clone(&self) -> SpecCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecCommand

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

Formats the value using the given formatter.

impl Default for SpecCommand

fn default() -> Self

Returns the “default value” for a type.

impl From<&SpecCommand> for KdlNode

fn from(cmd: &SpecCommand) -> Self

Converts to this type from the input type.

impl Serialize for SpecCommand

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

where __S: Serializer,

Serialize this value into the given Serde serializer.