Do we have command attribute "examples"?

[g2wang]

I saw derive code samples like
#[command(author, version, about, long_about = None)]
Do we have a command attribute "examples" alongside "author", "version", "about", and etc?
I need to give examples which must begin with the program name.
Currently I use the "after_help" attribute like
after_help="Examples: ...."
But I do not know how to dynamically put the program name into the Examples text. I have to hardcode the program name which is not ideal because if I rename the built binary executable, the hardcoded program name will be wrong.

[epage]

after_help is the recommended way of doing this. We do not have native support for examples. All of the existing attributes you mentioned have had a definitive way of being used but there is a lot of application-specific policy for how to list out examples.

You could use the help_template for this and then use the help template variables to fill in the names. We are unlikely to do anything more than that as normally a program's name is fairly static and the cost of making things more dynamic doesn't seem like it would provide enough benefit for the downsides. Even the help_template, I'd like to find a way to make it more of an optional feature than natively built-in.

[mawkler]

@epage I see, thank you! But can I use color_print with the "derive" style, or do I have to switch to the builder pattern?

[epage]

color_print doesn't make a difference between the two.

[mawkler]

@epage Sorry I'm probably misunderstanding you, but are you saying that I should be able to do something like this? I can't get it to work:

#[derive(Parser)]
#[command(
    after_help = "cformat!(\"<bold,underline>Examples:</bold,underline>\")\
    \n  foo --bar \
    \n  foo --baz \
    \n  foo --baz --fux
    "
)]
pub struct Cli;

[epage]

#[derive(Parser)]
#[command(
    after_help = cformat!("<bold,underline>Examples:</bold,underline>
  foo --bar
  foo --baz
  foo --baz --fux")
)]
pub struct Cli;

[mawkler]

Ah of course! Thank you very much for your help!