Struct CliBuilder 

pub struct CliBuilder { /* private fields */ }

Main builder for creating composable CLI applications

Examples

use clap_noun_verb::{CliBuilder, noun, verb, VerbArgs, Result};

fn main() -> Result<()> {
    let cli = CliBuilder::new()
        .name("myapp")
        .about("My application")
        .noun(noun!("services", "Manage services", [
            verb!("status", "Show status", |_args: &VerbArgs| {
                println!("Services are running");
                Ok(())
            }),
        ]));

    cli.run()
}

Implementations

impl CliBuilder

pub fn new() -> CliBuilder

Create a new CLI builder

pub fn name(self, name: impl Into<String>) -> CliBuilder

Set the application name

pub fn about(self, about: impl Into<String>) -> CliBuilder

Set the application description

pub fn version(self, version: impl Into<String>) -> CliBuilder

Set the application version

pub fn global_args(self, args: Vec<Arg>) -> CliBuilder

Add global arguments available to all commands

pub fn auto_validate(self, enable: bool) -> CliBuilder

Enable automatic validation of command structure

pub fn noun(self, noun: impl NounCommand + 'static) -> CliBuilder

Add a noun command to the CLI

pub fn nouns<I>(self, nouns: I) -> CliBuilder

where I: IntoIterator<Item = Box<dyn NounCommand>>,

Add multiple noun commands

pub fn run(self) -> Result<(), NounVerbError>

Run the CLI application

pub fn run_with_args(self, args: Vec<String>) -> Result<(), NounVerbError>

Run the CLI application with custom args

pub fn build_command(self) -> Command

Get the built command for testing or manual execution

pub fn registry(self) -> CommandRegistry

Get the underlying registry for advanced usage

pub fn registry_ref(&self) -> &CommandRegistry

Get a reference to the registry for introspection

pub fn command_structure(&self) -> HashMap<String, Vec<String>>

Get the command structure for introspection

pub fn has_command(&self, name: &str) -> bool

Check if a command exists

Trait Implementations

impl Default for CliBuilder

fn default() -> CliBuilder

Returns the “default value” for a type.