Disable automatic -h flag for help?

[teenjuna]

Hey! I have a following code:

#[derive(Parser)]
struct Args {
    #[clap(subcommand)]
    cmd: Command,
}

#[derive(Subcommand)]
enum Command {
    /// Generate a maze.
    Generate {
        /// Maze width.
        #[clap(short, long, default_value = "10")]
        width: usize,

        /// Maze height.
        #[clap(short, long, default_value = "10")]
        height: usize,

        /// Print ASCII representation to stdout.
        #[clap(short, long)]
        print_ascii: bool,

        /// Save ASCII representation to a file.
        #[clap(short = 'a', long)]
        save_ascii: Option<PathBuf>,

        /// Save JPEG representation to a file.
        #[clap(short = 'j', long)]
        save_jpeg: Option<PathBuf>,
    },
}

The argument height in generate subcommand conflicts with the short help flag -h. I would like to disable this flag, leaving only long flag --help. Is it possible?

[epage]

I don't think we have a way to unset the short flag on help but if you define your own help flag, we'll automatically do the help action for it and you can leave off the short.

[teenjuna]

So, this is the way:

#[derive(Subcommand)]
enum Command {
    /// Generate a maze.
    Generate {
        /// Print help information
        #[clap(long)]
        help: bool,
        
        ...
}

Thanks!

[daniel-brenot]

Sorry, this no longer seems to work for me? I tried it on the top level command and it said that the command requires a subcommand

[jgrund]

Is there a way to keep -h / --help, but force -h to output long help on top-level command?

[epage]

In your top-level command, you would disable help, write it yourself, and set the action to HelpLong

[dharkness]

The above changes didn't allow me to use -h for one of my options, but this did:

#[derive(Debug, Args)]
#[clap(disable_help_flag = true)]
pub struct PlayArgs {
    #[clap(long, action = clap::ArgAction::HelpLong)]
    help: Option<bool>,

    #[clap(short, long)]
    hidden: bool,
}