How do I add shell completion to my Typer app?

Use the --install-completion option when running your app or the typer command. Typer automatically detects the shell (Bash, Zsh, Fish, PowerShell) and installs completion scripts, making it user-friendly out of the box.

Typer vs Click: which should I use?

Typer is better if you value type hints and minimal boilerplate for rapid development, while Click offers more low-level control. Choose Typer for modern Python practices, or Click for fine-tuned customization without abstractions.

Can Typer handle file paths or custom validation?

Yes, Typer supports various types like paths and enums through Python type hints, and you can add custom validation. However, for complex validation, you might need to integrate with Pydantic or drop to Click for advanced logic.

How to create subcommands in Typer?

Use the @app.command() decorator on functions within a typer.Typer() app. Each function becomes a subcommand, and you can organize them into groups, as shown in the README's multi-command example.

Is Typer good for large CLI tools?

Yes, Typer scales well with subcommands and groups, but be mindful of dependency management and potential abstraction limitations if you need highly customized behavior beyond standard type hints.

What happened to typer-slim?

Typer-slim is no longer supported and now installs the full Typer package. If dependency size is critical, you might use Click directly or set TYPER_USE_RICH to False to disable rich formatting.

Open-Awesome

typer

MITPython0.24.2

A Python library for building command-line interfaces using type hints, designed for both developer productivity and user experience.

Visit Website GitHub

19.3k stars883 forks0 contributors

What is typer?

Typer is a Python library for building command-line interface applications that leverages Python type hints to automatically generate CLI arguments, options, and documentation. It simplifies CLI development by reducing boilerplate code and providing excellent editor support, while ensuring end-users get automatic help and shell completion.

Target Audience

Python developers who need to create command-line tools, from simple scripts to complex multi-command applications, and value type safety and developer productivity.

Value Proposition

Developers choose Typer because it combines the simplicity of Python's type hints with powerful CLI features, offering an intuitive development experience, automatic user-facing features, and seamless scalability without learning a new syntax.

Overview

Typer, build great CLIs. Easy to code. Based on Python type hints.

Use Cases

Best For

Converting existing Python scripts into full-featured CLI applications
Building multi-command CLI tools with subcommands and groups
Creating CLI applications with automatic help and shell completion
Developing type-safe command-line interfaces with minimal boilerplate
Rapid prototyping of CLI tools using Python's standard type system
Ensuring consistent user experience across different shell environments

Not Ideal For

Projects requiring fine-grained, low-level control over CLI parsing and behavior that Typer's abstraction layer hides
Environments with strict dependency or size constraints, as Typer bundles Click, rich, and shellingham
Teams already deeply invested in Click or argparse who don't need the type-hint convenience layer

Pros & Cons

Pros

Excellent Editor Support

Leverages Python type hints to provide IDE autocompletion and type checking throughout development, reducing bugs and speeding up coding as emphasized in the README.

Automatic User Features

Generates comprehensive --help documentation and supports shell auto-completion for Bash, Zsh, Fish, and PowerShell without extra code, enhancing end-user experience.

Minimal Boilerplate

Allows adding CLI functionality with just an import and function call, scaling to complex command trees, making it easy to start and grow applications.

Script Runner Capability

Includes a `typer` command that can convert existing Python scripts into CLI applications without modifying their code, enabling quick prototyping and migration.

Cons

Dependency Overhead

Requires Click, rich, and shellingham, adding bulk compared to minimalist alternatives; the typer-slim version is no longer supported, forcing these dependencies even if not needed.

Limited Customization

Built on Click, so accessing advanced or niche CLI features may require dropping down to Click directly, complicating development for edge cases.

Python-Only Solution

Exclusively for Python applications, making it unsuitable for multi-language projects or environments requiring language-agnostic CLI tools.

Frequently Asked Questions

Related Projects

rich

Rich is a Python library for rich text and beautiful formatting in the terminal.

Stars56,180

Forks2,118

Last commit12 days ago

textual

The lean application framework for Python. Build sophisticated user interfaces with a simple Python API. Run your apps in the terminal and a web browser.

Stars35,539

Forks1,181

Last commit2 days ago

python-fire

Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object.

Stars28,174

Forks1,477

Last commit23 days ago

click

Python composable command line interface toolkit

Stars17,425

Forks1,662

Last commit1 day ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub