Struct HelpPlugin 

pub struct HelpPlugin { /* private fields */ }

Standalone builtin providing only the help command.

Use this instead of [SystemPlugin][crate::builtin::system::SystemPlugin] when an application wants help without also registering version and exit.

YAML config

commands:
  - name: help
    implementation: system_help
    description: "Show help"
    aliases: ["h", "?"]
    required: false
    arguments: []
    options: []

Example

use dynamic_cli::plugin::{HelpPlugin, Plugin};

let builtin = HelpPlugin::new();
assert_eq!(builtin.name(), "help");

let handlers = builtin.handlers();
assert_eq!(handlers.len(), 1);
assert_eq!(handlers[0].0, "system_help");

Implementations

impl HelpPlugin

pub fn new() -> Self

Create a new HelpPlugin with no config attached.

Example

use dynamic_cli::plugin::{HelpPlugin, Plugin};

let builtin = HelpPlugin::new();
assert_eq!(builtin.name(), "help");

pub fn with_config(self, config: CommandsConfig) -> Self

Attach a config so the handler can render app/command help.

Call this yourself before register_plugin — CliBuilder::build() does not attach config to plugins on its own.

Example

use dynamic_cli::plugin::{HelpPlugin, Plugin};
use dynamic_cli::config::schema::{CommandsConfig, Metadata};

let config = CommandsConfig {
    metadata: Metadata {
        version: "1.0.0".to_string(),
        prompt: "myapp".to_string(),
        prompt_suffix: " > ".to_string(),
    },
    commands: vec![],
    global_options: vec![],
};

let builtin = HelpPlugin::new().with_config(config);
assert_eq!(builtin.name(), "help");

Trait Implementations

impl Default for HelpPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for HelpPlugin

fn name(&self) -> &str

Short identifier for this plugin (e.g. "system", "greet").

fn version(&self) -> &str

Semantic version string (e.g. "1.0.0").

fn description(&self) -> &str

Human-readable description of what this plugin provides.

fn handlers(&self) -> Vec<(String, Box<dyn CommandHandler>)>

Returns the handlers this plugin contributes.