Repolode
fastapi

fastapi/typer

標準の型ヒントからCLIアプリを構築できるPythonライブラリ。ヘルプ表示、入力検証、シェル補完を自動で提供します。

スター
20,155
フォーク
1,007
未解決の Issue
49
最終コミット
6 日前

これは何?

Typerは、コマンドラインインターフェースアプリを構築するためのPythonライブラリです。関数の引数を標準の型ヒントで宣言すると、TyperがそれをCLIの引数やオプションに変換し、解析、型変換、エラーメッセージの処理を行います。

アプリには自動で`--help`の出力が追加され、Bash、Zsh、Fish、PowerShellのシェル補完も利用できます。コマンドは、任意の深さで入れ子になったサブコマンドやグループとして整理できます。また、既存のPythonスクリプトを変更せずにCLIとして実行できる`typer`コマンドも付属します。

TyperはFastAPIの作者が設計しており、同じく型ヒントを中心とするスタイルを採用しています。整形された出力にはrich、シェルの検出にはshellinghamを使用し、バージョン0.26.0以降はClickの独自コピーを内部に同梱しています。

主な機能

  • 01Pythonの型ヒントからCLIの引数やオプションを構築します。
  • 02`--help`の出力を生成し、整形されたエラーを自動で表示します。
  • 03Bash、Zsh、Fish、PowerShellのシェル補完を提供します。
  • 04入れ子になったサブコマンドやコマンドグループに対応します。
  • 05通常のPythonスクリプトをCLIとして実行する`typer`コマンドが付属します。

ユースケース

  • 引数解析やヘルプ表示が必要な、開発者向けの内部スクリプトを作成する。
  • サブコマンドを備えた複数コマンド対応の管理ツールを構築する。
  • 既存のPythonスクリプトを書き直さずに、コマンドラインユーティリティとして利用する。

クイックスタート

  1. 1

    uvをインストールします(READMEにリンクされているインストールガイドを参照してください)

  2. 2

    プロジェクトにTyperを追加します

    uv add typer
  3. 3

    Typer組み込みのCLIランナーでスクリプトを実行します

    typer main.py run Camila

トピック

よくある質問

typer とは?
標準の型ヒントからCLIアプリを構築できるPythonライブラリ。ヘルプ表示、入力検証、シェル補完を自動で提供します。 Typerは、コマンドラインインターフェースアプリを構築するためのPythonライブラリです。関数の引数を標準の型ヒントで宣言すると、TyperがそれをCLIの引数やオプションに変換し、解析、型変換、エラーメッセージの処理を行います。
typer は無料で使えますか?ライセンスは?
typer は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
typer は今もメンテナンスされていますか?
活発にメンテナンス中。typer の最終コミットは 2026年10月15日 です。
typer は何に使えますか?
引数解析やヘルプ表示が必要な、開発者向けの内部スクリプトを作成する。 サブコマンドを備えた複数コマンド対応の管理ツールを構築する。 既存のPythonスクリプトを書き直さずに、コマンドラインユーティリティとして利用する。
typer のインストール方法は?
uvをインストールします(READMEにリンクされているインストールガイドを参照してください) プロジェクトにTyperを追加します: uv add typer Typer組み込みのCLIランナーでスクリプトを実行します: typer main.py run Camila
typer はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/fastapi/typer

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト