Struct ConfigCommand 

pub struct ConfigCommand { /* private fields */ }

Runtime-configurable alternative to ConfigArgs for apps that need to rename subcommands or flags to avoid conflicts.

Both ConfigArgs (derive) and ConfigCommand (builder) produce ConfigAction, so all downstream logic is shared.

Example

use clapfig::ConfigCommand;

let config_cmd = ConfigCommand::new()
    .scope_long("target")       // rename --scope to --target
    .gen_name("template");      // rename "gen" to "template"

let app = Cli::command()
    .subcommand(config_cmd.as_command("settings"));

let matches = app.get_matches();
if let Some(("settings", sub)) = matches.subcommand() {
    let action = config_cmd.parse(sub)?;
    builder.handle_and_print(&action)?;
}

Implementations

impl ConfigCommand

pub fn new() -> Self

Create a new ConfigCommand with default names matching ConfigArgs.

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

Rename the list subcommand.

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

Rename the gen subcommand.

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

Rename the schema subcommand.

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

Rename the get subcommand.

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

Rename the set subcommand.

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

Rename the unset subcommand.

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

Rename the --scope flag.

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

Rename the --output flag on the gen subcommand.

pub fn output_short(self, short: Option<char>) -> Self

Set or disable the short flag for --output (default: Some('o')). Pass None to remove the short flag entirely.

pub fn as_command(&self, name: &str) -> Command

Build a clap::Command with the configured names.

The name parameter sets the top-level subcommand name (e.g. "config", "settings").

pub fn parse(&self, matches: &ArgMatches) -> Result<ConfigAction, ClapfigError>

Extract a ConfigAction from parsed ArgMatches.

Bare invocation (no subcommand) maps to ConfigAction::List, matching the behavior of ConfigArgs::into_action.

Trait Implementations

impl Default for ConfigCommand

fn default() -> Self

Returns the “default value” for a type.