Skip to main content

spec

ctl_core::usage

Function spec 

Source 
pub fn spec(command: Command, bin: &str) -> String
Available on crate feature usage only.
Expand description

Render the Usage KDL spec of command as a mise task named bin.

Both the spec’s name and bin are set to bin, so mise shows the task name and not the real binary name. Every string reads back unchanged under KDL v2: a character KDL v2 forbids literally is written escaped.

§Panics

Panics when an argument conflicts with an id that is neither an argument nor a group of its command, as Command::get_arg_conflicts_with does.