typer README

The project's README from github.com/fastapi/typer. As one markdown file: README.md.

Typer

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

Test Coverage Package version

Documentation: https://typer.tiangolo.com

Source Code: https://github.com/fastapi/typer

Typer is a library for building CLI applications that users will love using and developers will love creating. Based on Python type hints.

It's also a command line tool to run scripts, automatically converting them to CLI applications.

The key features are:

FastAPI of CLIs

Typer is FastAPI's little sibling, it's the FastAPI of CLIs.

Installation

First, install uv, and then add Typer to your project:

$ uv add typer
---> 100%

This installs both the Typer library and the typer command in the project's virtual environment. To use typer directly with shell completion, activate the project environment and install completion.

If you prefer to use pip, install typer inside a virtual environment. See the installation guide for the alternative steps.

Example

The absolute minimum

def main(name: str):
    print(f"Hello {name}")

This script doesn't even use Typer internally. But you can use the typer command to run it as a CLI application.

Run it

Run your application with the typer command:

// Run your application
$ typer main.py run

// You get a nice error, you are missing 'name'
Usage: typer [PATH_OR_MODULE] run [OPTIONS] {name}
Try 'typer [PATH_OR_MODULE] run --help' for help.
╭─ Error ───────────────────────────────────────────╮
│ Missing argument 'name'.                          │
╰───────────────────────────────────────────────────╯


// You get a --help for free
$ typer main.py run --help

Usage: typer [PATH_OR_MODULE] run [OPTIONS] {name}

Run the provided Typer app.

╭─ Arguments ───────────────────────────────────────╮
│ *    name      <str>  [required]                  │
╰───────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────╮
│ --help          Show this message and exit.       │
╰───────────────────────────────────────────────────╯

// Now pass the 'name' argument
$ typer main.py run Camila

Hello Camila

// It works! 🎉

This is the simplest use case, not even using Typer internally, but it can already be quite useful for simple scripts.

Note: auto-completion works when you create a Python package and run it with --install-completion or when you use the typer command.

Use Typer in your code

Now let's start using Typer in your own code, update main.py with:

import typer


def main(name: str):
    print(f"Hello {name}")


if __name__ == "__main__":
    typer.run(main)

Now you could run it with Python directly:

// Run your application
$ uv run python main.py

// You get a nice error, you are missing 'name'
Usage: main.py [OPTIONS] {name}
Try 'main.py --help' for help.
╭─ Error ───────────────────────────────────────────╮
│ Missing argument 'name'.                          │
╰───────────────────────────────────────────────────╯


// You get a --help for free
$ uv run python main.py --help

Usage: main.py [OPTIONS] {name}

╭─ Arguments ───────────────────────────────────────╮
│ *    name      <str>  [required]                  │
╰───────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────╮
│ --help          Show this message and exit.       │
╰───────────────────────────────────────────────────╯

// Now pass the 'name' argument
$ uv run python main.py Camila

Hello Camila

// It works! 🎉

Note: you can also call this same script with the typer command, but you don't need to.

Example upgrade

This was the simplest example possible.

Now let's see one a bit more complex.

An example with two subcommands

Modify the file main.py.

Create a typer.Typer() app, and create two subcommands with their parameters.

import typer

app = typer.Typer()


@app.command()
def hello(name: str):
    print(f"Hello {name}")


@app.command()
def goodbye(name: str, formal: bool = False):
    if formal:
        print(f"Goodbye Ms. {name}. Have a good day.")
    else:
        print(f"Bye {name}!")


if __name__ == "__main__":
    app()

And that will:

Run the upgraded example

Check the new help:

$ uv run python main.py --help

 Usage: main.py [OPTIONS] COMMAND [ARGS]...

╭─ Options ─────────────────────────────────────────╮
│ --install-completion          Install completion  │
│                               for the current     │
│                               shell.              │
│ --show-completion             Show completion for │
│                               the current shell,  │
│                               to copy it or       │
│                               customize the       │
│                               installation.       │
│ --help                        Show this message   │
│                               and exit.           │
╰───────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────╮
│ hello                                             │
│ goodbye                                           │
╰───────────────────────────────────────────────────╯

// When you create a package you get ✨ auto-completion ✨ for free, installed with --install-completion

// You have 2 subcommands (the 2 functions): hello and goodbye

Now check the help for the hello command:

$ uv run python main.py hello --help

 Usage: main.py hello [OPTIONS] {name}

╭─ Arguments ───────────────────────────────────────╮
│ *    name      <str>  [required]                  │
╰───────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────╮
│ --help          Show this message and exit.       │
╰───────────────────────────────────────────────────╯

And now check the help for the goodbye command:

$ uv run python main.py goodbye --help

 Usage: main.py goodbye [OPTIONS] {name}

╭─ Arguments ───────────────────────────────────────╮
│ *    name      <str>  [required]                  │
╰───────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────╮
│ --formal    --no-formal      [default: no-formal] │
│ --help                       Show this message    │
│                              and exit.            │
╰───────────────────────────────────────────────────╯

// Automatic --formal and --no-formal for the bool option 🎉

Now you can try out the new command line application:

// Use it with the hello command

$ uv run python main.py hello Camila

Hello Camila

// And with the goodbye command

$ uv run python main.py goodbye Camila

Bye Camila!

// And with --formal

$ uv run python main.py goodbye --formal Camila

Goodbye Ms. Camila. Have a good day.

Note: If your app only has one command, by default the command name is omitted in usage: python main.py Camila. However, when there are multiple commands, you must explicitly include the command name: python main.py hello Camila. See One or Multiple Commands for more details.

Recap

In summary, you declare once the types of parameters (CLI arguments and CLI options) as function parameters.

You do that with standard modern Python types.

You don't have to learn a new syntax, the methods or classes of a specific library, etc.

Just standard Python.

For example, for an int:

total: int

or for a bool flag:

force: bool

And similarly for files, paths, enums (choices), etc. And there are tools to create groups of subcommands, add metadata, extra validation, etc.

You get: great editor support, including completion and type checks everywhere.

Your users get: automatic --help, auto-completion in their terminal (Bash, Zsh, Fish, PowerShell) when they install your package or when using the typer command.

For a more complete example including more features, see the Tutorial - User Guide.

Dependencies

Typer requires only a few dependencies (most are tiny):

Click code

Typer used to depend on Click as well, a popular tool for building CLIs in Python.

Since version 0.26.0, Typer has vendored Click (included Click's source code internally, instead of installing it as a third party package) and has unified the code interactions between Typer and the embedded Click source code for easier maintainability in the future.

Note that some Click functionality will not be available anymore in the future, as we continue to improve and extend Typer's codebase.

typer-slim

There used to be a slimmed-down version of Typer called typer-slim, which didn't include the dependencies rich and shellingham, nor the typer command.

However, since version 0.22.0, we have stopped supporting this, and typer-slim now simply installs (all of) Typer.

If you want to disable Rich globally, you can set an environmental variable TYPER_USE_RICH to False or 0.

License

This project is licensed under the terms of the MIT license.

typer (fastapi/typer)

Searching Database…

20.1K ·GitHub
Typer
Что это?Typer — это библиотека для Python, с помощью которой создают приложения командной строки: вы пишете обычные функции на Python, указываете их параметры стандартными подсказками типов, и получаете аккуратный CLI с автоматической справкой и автодополнением.
Это библиотека, которую я импортирую, или утилита, которую я запускаю в терминале?И то, и другое. Вы импортируете Typer в свой код на Python, чтобы описать CLI-приложение, а в комплекте с пакетом идёт команда typer, которая запускает любой скрипт на Python как CLI — даже те, что вообще не используют Typer.
Как добавить его в свой проект?Установите uv, затем выполните 'uv add typer' — это поставит и библиотеку Typer, и команду typer в виртуальное окружение вашего проекта. Если вы предпочитаете pip, установите typer внутри виртуального окружения.
Он не потянет за собой кучу зависимостей в мой проект?Нет, всего несколько небольших пакетов: rich для красиво отформатированных ошибок, shellingham для определения вашей текущей оболочки, annotated-doc для документации из аннотаций и colorama на Windows. Click отдельно больше не нужен — начиная с версии 0.26.0 его код встроен прямо в Typer.
Как запустить приложение, когда у него больше одной команды?Если команда одна, её имя в вызове не указывается: python main.py Camila. Если команд несколько, имя нужно писать явно: python main.py hello Camila.
Можно ли использовать его в коммерческих проектах?Да — Typer распространяется по лицензии MIT, поэтому его можно свободно использовать и поставлять где угодно, в том числе в коммерческом ПО.
Как выглядит самое маленькое приложение на Typer?Две строки кода: один импорт и один вызов функции. Скрипту даже не обязательно использовать Typer внутри — команда typer всё равно сможет запустить его как CLI-приложение.
Как сделать приложение с несколькими подкомандами?Создайте приложение typer.Typer(), повесьте на каждую функцию декоратор @app.command() и в конце вызовите app(). Каждая функция станет подкомандой, а подкоманды можно группировать в сколь угодно сложные деревья.
Почему его называют FastAPI для CLI?Typer — младший брат FastAPI и разделяет его главную идею: объявляйте параметры стандартными современными типами Python — int, bool, файлы, пути, перечисления для вариантов выбора — и получайте автодополнение в редакторе, проверку типов и валидацию, не изучая специфичный синтаксис библиотеки.
У приложений на Typer будет автодополнение в оболочке для пользователей?Да: автоматическая справка --help и автодополнение по Tab в Bash, Zsh, Fish и PowerShell — либо когда пользователи устанавливают ваш пакет, либо когда запускают его через команду typer.
What are similar projects?click, bashka, fish-shell, PowerShell, RustPython, rich, awesome-zsh-plugins, git-filter-repo
Which topics is it in?click, autocomplete, scripting, python3, python-library, fastapi, cli-tool, shell, developers, framework, terminal, library
Creator
fastapi
Size
4 MB
Stars
20.1K
Updated
CommitOct 15Release0.27.3Oct 06
Age
6y
Commits · 90 Days