Struct CliConfig 

pub struct CliConfig {

    pub name: String,
    pub short: String,
    pub long: Option<String>,
    pub build: BuildInfo,
    pub app_id: String,
    pub default_auth_provider: Option<String>,
    pub modules: Vec<Module>,
    pub commands: Vec<RuntimeCommandSpec>,
    pub guides: Vec<GuideEntry>,
    pub views: Vec<HumanViewDef>,
    pub auth_providers: Vec<Arc<dyn AuthProvider>>,
    pub init_deps: Option<InitDeps>,
    pub register_flags: Option<RegisterFlags>,
    pub apply_flags: Option<ApplyFlags>,
    pub pre_run: Option<PreRun>,
    pub meta_resolver: Option<ResolveMeta>,
    pub on_shutdown: Option<OnShutdown>,
    pub extra_search_docs: Option<ExtraSearchDocs>,
}

Declarative configuration for a CLI application.

Use CliConfig::new for the common path and chain with_* methods for modules, auth providers, guides, views, and lifecycle hooks. Direct struct literals remain available for advanced setup and tests.

Fields

name: String

Root command name shown in usage output.

short: String

One-line root command description.

long: Option<String>

Optional longer root command description. Defaults to short.

build: BuildInfo

Version/build metadata for --version.

app_id: String

Application id stored in middleware and output metadata.

default_auth_provider: Option<String>

Fallback auth provider when a command does not select one explicitly.

modules: Vec<Module>

Domain modules mounted under the root command.

commands: Vec<RuntimeCommandSpec>

Additional top-level runtime commands.

guides: Vec<GuideEntry>

Global guide entries mounted under guide.

views: Vec<HumanViewDef>

Global human output views.

auth_providers: Vec<Arc<dyn AuthProvider>>

Providers registered before command execution starts.

init_deps: Option<InitDeps>

Optional late initializer for runtime dependencies.

register_flags: Option<RegisterFlags>

Optional hook for adding application-specific global flags.

apply_flags: Option<ApplyFlags>

Optional hook for applying parsed application-specific flags.

pre_run: Option<PreRun>

Optional hook run before executable commands and built-ins.

meta_resolver: Option<ResolveMeta>

Optional hook for global command metadata adjustments.

on_shutdown: Option<OnShutdown>

Optional hook called after each run.

extra_search_docs: Option<ExtraSearchDocs>

Optional root-scope search document provider.

Implementations

impl CliConfig

pub fn new( name: impl Into<String>, short: impl Into<String>, app_id: impl Into<String>, ) -> Self

Creates the minimum useful CLI configuration.

pub fn with_long(self, long: impl Into<String>) -> Self

Sets root long help text.

pub fn with_build(self, build: BuildInfo) -> Self

Sets build metadata used by --version.

pub fn with_default_auth_provider(self, provider: impl Into<String>) -> Self

Sets the fallback auth provider for commands that do not name one.

pub fn with_module(self, module: Module) -> Self

Adds one domain module.

pub fn with_modules(self, modules: impl IntoIterator<Item = Module>) -> Self

Adds several domain modules.

pub fn with_command(self, command: RuntimeCommandSpec) -> Self

Adds a top-level runtime command outside a module.

pub fn with_guide(self, guide: GuideEntry) -> Self

Adds one global guide.

pub fn with_guides(self, guides: impl IntoIterator<Item = GuideEntry>) -> Self

Adds several global guides.

pub fn with_view(self, view: HumanViewDef) -> Self

Adds one global human view.

pub fn with_auth_provider(self, provider: Arc<dyn AuthProvider>) -> Self

Registers one auth provider.

pub fn with_init_deps(self, init_deps: InitDeps) -> Self

Sets the late dependency initializer.

pub fn with_register_flags(self, register_flags: RegisterFlags) -> Self

Sets the application-specific global flag registration hook.

pub fn with_apply_flags(self, apply_flags: ApplyFlags) -> Self

Sets the application-specific parsed flag application hook.

pub fn with_pre_run(self, pre_run: PreRun) -> Self

Sets the pre-run hook.

pub fn with_meta_resolver(self, meta_resolver: ResolveMeta) -> Self

Sets the command metadata resolver hook.

pub fn with_on_shutdown(self, on_shutdown: OnShutdown) -> Self

Sets the shutdown hook.

pub fn with_extra_search_docs(self, extra_search_docs: ExtraSearchDocs) -> Self

Sets the provider for additional root-scope search documents.

Trait Implementations

impl Clone for CliConfig

fn clone(&self) -> CliConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CliConfig

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

Formats the value using the given formatter.

impl Default for CliConfig

fn default() -> CliConfig

Returns the “default value” for a type.