標準の型ヒントからCLIアプリを構築できるPythonライブラリ。ヘルプ表示、入力検証、シェル補完を自動で提供します。
pallets/click
ネストしたコマンド、自動生成されるヘルプ、遅延読み込みのサブコマンドに対応した、合成可能なCLIを構築するためのPythonツールキットです。
- スター
- 17,817
- フォーク
- 3,296
- 未解決の Issue
- 89
- 最終コミット
- 22 時間前
これは何?
Clickは、コマンドラインツールを作成するためのPythonパッケージです。開発者はデコレーターでコマンド、オプション、引数を定義し、Clickが解析、検証、入力の促し、ヘルプテキストの生成を担います。コマンドは任意の深さまでネストでき、サブコマンドは実行時に遅延読み込みできます。
ライブラリは柔軟に設定できますが、初期設定のままでもすぐに使えます。基本的なプログラムは、デコレーターを付けた関数とコマンドオブジェクトの呼び出しだけで作成できます。また、オプション処理にはデフォルト値、対話形式の入力プロンプト、ヘルプ出力の自動生成などの機能があります。
ClickはPallets組織のもとで開発され、BSD-3-Clauseライセンスで公開されています。引数解析を自分で実装せずにCLIを構築したいPython開発者を対象としています。
主な機能
- 01デコレーターによるコマンド、オプション、引数の定義
- 02コマンドとサブコマンドを任意の深さまでネスト
- 03ヘルプページの自動生成
- 04実行時のサブコマンドの遅延読み込み
- 05オプション値が不足している場合の対話形式の入力プロンプト
ユースケース
- 複数のサブコマンドを備えたPython製コマンドラインツールの構築
- 引数が不足しているときにユーザーへ入力を促すスクリプトの作成
- 手書きのargparseコードを、より簡潔なデコレータ形式に置き換える
クイックスタート
- 1
pipでClickをインストールする
pip install click - 2
例をhello.pyとして保存し、実行する
python hello.py --count=3
収録されている特集
トピック
よくある質問
- click とは?
- ネストしたコマンド、自動生成されるヘルプ、遅延読み込みのサブコマンドに対応した、合成可能なCLIを構築するためのPythonツールキットです。 Clickは、コマンドラインツールを作成するためのPythonパッケージです。開発者はデコレーターでコマンド、オプション、引数を定義し、Clickが解析、検証、入力の促し、ヘルプテキストの生成を担います。コマンドは任意の深さまでネストでき、サブコマンドは実行時に遅延読み込みできます。
- click は無料で使えますか?ライセンスは?
- click は BSD-3-Clause ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
- click は今もメンテナンスされていますか?
- 活発にメンテナンス中。click の最終コミットは 2026年11月6日 です。
- click は何に使えますか?
- 複数のサブコマンドを備えたPython製コマンドラインツールの構築 引数が不足しているときにユーザーへ入力を促すスクリプトの作成 手書きのargparseコードを、より簡潔なデコレータ形式に置き換える
- click のインストール方法は?
- pipでClickをインストールする: pip install click 例をhello.pyとして保存し、実行する: python hello.py --count=3
- click はどこで入手できますか?
- ソースコードとインストール手順は GitHub にあります:https://github.com/pallets/click
概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。
関連プロジェクト
サブコマンド、フラグ、シェル補完、ヘルプ生成に対応した、CLI構築用の宣言的なGoパッケージ。
宣言的にも手続き的にも定義できる、コマンドライン引数パーサー構築用の高機能なRustライブラリです。
アノテーションまたはプログラムによるAPIでCLIアプリを構築でき、サブコマンド、ANSIカラー、シェル補完にも対応するJavaフレームワークです。
ヘルプを自動生成できる、コマンドライン引数を型安全に宣言・解析するSwiftライブラリ。
複数のGitリポジトリの状態を並べて確認し、まとめてGitコマンドやシェルコマンドを実行できるCLIツール。