✨ Add optional parameter to enable command suggestions

[savannahostrowski]

This PR adds a common CLI feature as optional to Typer (i.e. off by default), allowing users to enable command suggestions for typos (similar to the recently added suggest_on_error feature in argparse) without any additional dependency.

Usage

import typer

app = typer.Typer(suggest_commands=True)

@app.command()
def create():
    typer.echo("Creating...")

@app.command()
def delete():
    typer.echo("Deleting...")

if __name__ == "__main__":
    app()

If a user were to type crate instead of create, they would then see an error message like so:

Error: No such command 'crate'. Did you mean 'create'?

[github-actions]

📝 Docs preview

Last commit 80f199d at: https://65ce4615.typertiangolo.pages.dev

Modified Pages

• https://65ce4615.typertiangolo.pages.dev/tutorial/commands/help/ - (before)

[svlandeg]

I think this is a great feature to have, and I would have even wanted to enable this by default. But to minimize unexpected impact on users it probably makes sense to have it disabled by default as you suggest.

Love all the tests, went through it all and all looked good. Addition to the tutorial is perfect and the added code is minimal and clean.

Could really only find the smallest of nitpicks, but happy to approve either way. 😉