Struct HelpConfig 

pub struct HelpConfig {
    pub default_scope: HelpScope,
    pub default_format: HelpFormat,
    pub recursive_flag: Option<&'static str>,
    pub output_flag: Option<&'static str>,
    pub allow_output_format: bool,
    pub protocol_mode: CliProtocolMode,
}

Configuration for pre-clap help handling.

The handler scans raw argv before Cli::try_parse() so applications can support requests such as --help --output markdown without clap exiting early with DisplayHelp.

Requires the cli-help feature.

Fields

default_scope: HelpScope

Scope used for --help / -h when neither --recursive nor a configured recursive_flag is present.

default_format: HelpFormat

Format used for help when no explicit output flag is present.

recursive_flag: Option<&'static str>

Optional extra alias for the built-in --recursive scope modifier.

--recursive is always recognized; set this only to accept an additional custom flag name (for example --full). Like --recursive, the alias is a modifier that selects recursive scope when --help is present; on its own it does not trigger help.

output_flag: Option<&'static str>

Optional output flag to read help format from, for example --output.

allow_output_format: bool

Whether an explicit output flag can override default_format.

protocol_mode: CliProtocolMode

Envelope mode for structured help output and early errors.

Implementations

impl HelpConfig

pub const fn new(default_scope: HelpScope, default_format: HelpFormat) -> Self

Construct a custom help handler configuration.

pub const fn human_cli_default() -> Self

Recommended preset for human-facing CLIs.

--help renders one-level plain help by default. Scope and format are orthogonal: --recursive expands the selected command subtree, while --output json|yaml|markdown picks the format. So --help --recursive is recursive plain text and --help --recursive --output markdown is a recursive Markdown export.

pub const fn agent_cli_default() -> Self

Recommended preset for agent-first CLIs that want full surface help by default.

pub const fn with_default_scope(self, scope: HelpScope) -> Self

Return a copy with a different default scope.

pub const fn with_default_format(self, format: HelpFormat) -> Self

Return a copy with a different default format.

pub const fn with_recursive_flag(self, flag: Option<&'static str>) -> Self

Return a copy with a different recursive-help flag.

pub const fn with_output_flag(self, flag: Option<&'static str>) -> Self

Return a copy with a different output flag.

pub const fn with_output_format_override(self, enabled: bool) -> Self

Return a copy that enables or disables help format overrides.

pub const fn with_protocol_v1(self) -> Self

Return a copy that wraps JSON/YAML help in a protocol-v1 result event.

Trait Implementations

impl Clone for HelpConfig

fn clone(&self) -> HelpConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpConfig

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

Formats the value using the given formatter.

impl Eq for HelpConfig

impl PartialEq for HelpConfig

fn eq(&self, other: &HelpConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HelpConfig