Feature request: simpler way to add -h as help option alias?

[paugier]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

app = typer.Typer(add_help_option=False)

@app.callback()
def main(
    ctx: typer.Context,
    help: bool = typer.Option(False, "--help", "-h", help="Show this message and exit."),
):
    if help:
        typer.echo(ctx.get_help())
        raise typer.Exit()

Description

Many CLI tools support both --help and -h for displaying help. Currently, adding -h support in Typer requires significant boilerplate code (something like the example). I understand the current behavior is intentional, but it would be helpful to have a simpler opt-in mechanism.

The current solution is quite verbose for a common use case.

Something like this could be supported:

app = typer.Typer(add_short_help=True)

or ?

app = typer.Typer(help_option_names=["--help", "-h"])

Operating System

Linux, Windows, macOS

Operating System Details

No response

Typer Version

0.20.0

Python Version

3.11

Additional Context

No response

[paugier]

I finally found the solution in the repo in tests/test_others.py

app = typer.Typer(
    ...,
    context_settings={"help_option_names": ["-h", "--help"]},
)

I was not able to find it in the documentation. It seems that it is nowhere in the documentation.

[svlandeg]

Hi!

It's kind of hidden in the documentation, over at https://typer.tiangolo.com/tutorial/commands/context/#configuring-the-context. On Click's documentation, you can find the parameters you can set with context_settings. help_option_names is one of them (as you figured out by now).

[paugier]

IMHO, the string "help_option_names" should be somewhere in the Typer documentation so that it can be found when people search for "--help" or "help".

[svlandeg]

I'm currently writing the reference docs for Typer, and I'm using help_option_names as an example for context_settings, so it'll be searchable.