✨ Enable command suggestions on typo by default

[savannahostrowski]

This PR adds a common CLI feature to Typer, which allows users to get suggestions for command typos out of the box. No extra dependency or work required!

Usage

import typer

app = typer.Typer()

@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 a4d590b at: https://923dd50a.typertiangolo.pages.dev

Modified Pages

• https://923dd50a.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. 😉

[tiangolo]

Awesome, thank you! 🚀

---

Note: just for completeness, I asked on another channel to have this enabled by default, so it is now on by default. 😎 🎉

---

This will be available in the next hours in Typer 0.20.0.