Struct Command 

pub struct Command {
    pub name: &'static str,
    pub summary: &'static str,
    pub detail: &'static str,
    pub params: &'static [Param],
    pub cli_only: Option<&'static str>,
    pub writes: Writes,
    pub run: fn(&mut Context, &Arguments) -> Result<Outcome, Failed>,
}

One command.

Fields

name: &'static str

The verb, as inillucent <name> and as inillucent_<name>.

summary: &'static str

One line, shown in the command list and used as the MCP description.

detail: &'static str

The longer explanation, shown by inillucent help <name> and appended to the MCP description so a model reads the same thing a person does.

params: &'static [Param]

What it takes.

cli_only: Option<&'static str>

Why it is not offered over MCP, when it is not.

writes: Writes

Whether it can change the database, and what a read only surface does about it.

run: fn(&mut Context, &Arguments) -> Result<Outcome, Failed>

What it does.

Implementations

impl Command

pub fn param(&self, name: &str) -> Option<&'static Param>

Returns this command’s parameter of a given name.

@param name - the parameter name

pub fn positional(&self) -> Option<&'static Param>

Returns the parameter that may be written without its name.

pub fn usage(&self) -> String

Returns the usage line the CLI prints for this command.

pub fn allowed_values(&self, name: &str) -> Option<&'static [&'static str]>

Returns the finite text values a parameter accepts when it has any.

@param name - the parameter name