Struct Cli 

pub struct Cli { /* private fields */ }

Configured CLI application.

A Cli owns the clap command tree, middleware, registered runtime commands, guides, schemas, and built-ins. Consumer binaries normally create one Cli and call Cli::execute.

Implementations

impl Cli

pub fn new(config: CliConfig) -> Self

Builds a CLI application from declarative configuration.

pub fn middleware(&self) -> &Middleware

Returns the shared middleware template.

pub fn middleware_mut(&mut self) -> &mut Middleware

Returns mutable middleware for advanced application setup.

pub async fn execute(&self) -> ExitCode

Executes the CLI with process arguments and process stdout/stderr.

pub async fn execute_from<I, S, O, E>( &self, args: I, stdout: &mut O, stderr: &mut E, ) -> Result<ExitCode>

where I: IntoIterator<Item = S>, S: Into<OsString> + Clone, O: Write, E: Write,

Executes the CLI with caller-provided args and output writers.

pub async fn execute_from_until_signal<I, S, O, E, Shutdown>( &self, args: I, stdout: &mut O, stderr: &mut E, shutdown: Shutdown, ) -> Result<ExitCode>

where I: IntoIterator<Item = S>, S: Into<OsString> + Clone, O: Write, E: Write, Shutdown: Future<Output = ()>,

Executes the CLI until either command completion or a shutdown signal future resolves.

pub fn register_auth_provider( &mut self, provider: Arc<dyn AuthProvider>, ) -> &mut Self

Registers an auth provider after construction.

pub fn root_command(&self) -> &Command

Returns the built clap root command.

pub fn add_module_group( &mut self, category: impl Into<String>, group: RuntimeGroupSpec, ) -> &mut Self

Adds one runtime module group after construction.

pub fn add_module(&mut self, module: Module) -> &mut Self

Adds one module after construction.

pub fn add_command(&mut self, command: RuntimeCommandSpec) -> &mut Self

Adds one top-level runtime command after construction.

pub fn set_has_guide(&mut self, has_guide: bool) -> &mut Self

Controls whether the built-in guide command is advertised.

pub fn add_guides( &mut self, entries: impl IntoIterator<Item = GuideEntry>, ) -> &mut Self

Adds guide entries after construction.

pub async fn run<I, S>(&self, args: I) -> CliRunOutput

where I: IntoIterator<Item = S>, S: Into<OsString> + Clone,

Runs the CLI with provided args and captures the rendered result.

Trait Implementations

impl Clone for Cli

fn clone(&self) -> Cli

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cli

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

Formats the value using the given formatter.