Hide subcommand

[segeljakt]

Make sure you completed the following tasks

• Searched the discussions
• Searched the closed issues

Describe your use case

I'm trying to make Clap ignore certain subcommands in my Opt data structure. These sub-commands should only be accessible when using my application as a library.

Describe the solution you'd like

I'd like there to be a #[clap(hidden)] which can be used for sub-commands:

#[derive(Clap)]
pub struct Opt {
    #[clap(short, long, parse(from_occurrences))]
    pub verbose: i32,
    // ...
    #[clap(subcommand)]
    SubCommand(SubCommand),
}
#[derive(Clap)]
pub enum SubCommand {
    #[clap(name = "run")]
    Run(RunCommand),
    #[clap(name = "build")]
    Build(BuildCommand),
    #[clap(name = "check")]
    Check(CheckCommand),
    #[clap(hidden)] // <---- addition
    Lib(LibCommand),
}
#[derive(Clap)]
pub struct RunCommand {
    /// Path to main file
    #[clap(parse(from_os_str), name = "main")]
    pub main: Option<PathBuf>,
}
// ...
pub struct LibCommand {
    /// Input source string.
    pub source: String,
}

I thought it was already possible, but I get error: unexpected attribute: hidden

Alternatives, if applicable

My current alternative is to use configure with cfg_attr to avoid Clap when using the crate as a library, i.e.:

#[cfg_attr(feature = "cli", derive(Clap))]
pub enum SubCommand {
    #[cfg_attr(feature = "cli", clap(name = "run"))]
    Run(RunCommand),
    #[cfg_attr(feature = "cli", clap(name = "build"))]
    Build(BuildCommand),
    #[cfg_attr(feature = "cli", clap(name = "check"))]
    Check(CheckCommand),
    #[cfg(feature = "lib")]
    Lib(LibCommand),
}

[pksunkara]

Try #[clap(setting = AppSettings::Hidden)]. The error you are getting is correct because hidden does not exist for clap::App

[leiteg]

If you stumble upon this discussion and are using a newer version of Clap (~ 4.0), here's how to do it:

#[derive(Subcommand)]
pub enum SubCommand {
    // ...
    #[command(hide = true)]
    Lib(LibCommand),
}