Ambiguous property: Command.name

[matteosantama]

Hi there, I've just started using clap and overall it's been a very positive experience, but there's one point that's been a source of confusion for me. It's unclear what the Command.name attribute is used for. I would have thought it changed the invocation name of my program.

For example, suppose I have the following in my Cargo.toml

[package]
name = "my-prog"

and in main.rs

use clap::{Parser, Subcommand};

#[derive(Parser)]
#[command(name = "different-name")]
struct Cli {
    #[command(subcommand)]
    command: Commands
}

#[derive(Subcommand)]
enum Commands {
    Start
}

fn main() {
    let args = Cli::parse();

    match args.command {
        Commands::Start => println!("Hello, World!")
    }
}

I would have thought after cargo install --path . my program would be invokable with different-name, but it is not. What changes should I see after manually setting the name attribute?

[epage]

Command::name unfortunately cannot change anything about how cargo compiles your binary.

Command::name is implicitly set for subcommands, like you Start subcommand. For top-level commands, it can act as a display name in --help though we no longer add it to --help by default. One example use is cargo subcommands.