メインコンテンツにスキップ

dart pub

pub パッケージマネージャー は、flutter ツール または dart ツール のいずれかで動作するコマンドラインインターフェースを備えています。どちらのツールでも、pub コマンドの後に get のようなサブコマンドを追加します。

dart pub get    # Gets dependencies for a non-Flutter package
flutter pub get # Gets dependencies for a Flutter package

このサイトでは例で dart pub <subcommand> を使用していますが、現在のディレクトリに Flutter アプリやその他の Flutter 固有のコードが含まれている場合は、代わりに flutter pub <subcommand> を使用してください。詳細については、Flutter ウェブサイトパッケージの使用 を参照してください。

pub ツールを使用する際に問題が発生した場合は、Pub のトラブルシューティング を参照してください。

サブコマンド一覧

#

以下の pub サブコマンドごとに詳細なドキュメントがあります。

サブコマンドの概要

#

Pub のサブコマンドは以下のカテゴリに分類されます。

パッケージ依存関係の管理

#

Pub は、コードが依存するパッケージ を管理するための多くのサブコマンドを提供します。

このグループで最も一般的に使用されるサブコマンドは getupgrade で、これらはパッケージによって使用される依存関係を取得またはアップグレードします。pubspec ファイルを変更するたびに、dart pub get または flutter pub get を実行して、依存関係が最新であることを確認してください。一部の IDE は、プロジェクトの作成時や pubspec の変更時にこのステップを自動的に実行します。

cache
Pub のローカルパッケージキャッシュを管理します。このサブコマンドを使用して、パッケージをキャッシュに追加したり、キャッシュ内のすべてのパッケージをクリーン再インストールしたりします。
deps
現在のパッケージが使用するすべての依存関係を一覧表示します。
downgrade
現在のパッケージの依存関係としてリストされているすべてのパッケージの最小バージョンを取得します。パッケージの依存関係の下限をテストするために使用します。
get
現在のパッケージの依存関係としてリストされているパッケージを取得します。pubspec.lock ファイルが既に存在する場合、ロックファイルにリストされているバージョン(可能な場合)を取得します。必要に応じてロックファイルを作成または更新します。
outdated
現在のパッケージが依存するすべてのパッケージを確認し、どのパッケージ依存関係が古いかを判断し、それらを更新する方法についてのガイダンスを提供します。パッケージ依存関係を更新したい場合に使用します。
upgrade
現在のパッケージの依存関係としてリストされている各パッケージの最新バージョンを取得します。pubspec.lock ファイルが存在する場合、ロックファイルにリストされているバージョンを無視し、pubspec の制約を満たす最新バージョンを取得します。必要に応じてロックファイルを作成または更新します。

コマンドラインアプリの実行

#

global サブコマンドを使用すると、パッケージをグローバルに利用可能にすることができ、そのパッケージの bin ディレクトリからスクリプトを実行できます。グローバルに利用可能なスクリプトを実行するには、システムキャッシュの bin ディレクトリをパスに追加 する必要があります。

パッケージとアプリのデプロイ

#

pub を使用すると、パッケージやコマンドラインアプリを公開できます。

パッケージ

#

Dart パッケージを世界と共有するために、publish サブコマンドを使用してパッケージを pub.dev サイト にアップロードできます。他のユーザーがパッケージを編集したり新しいバージョンをアップロードできるようにすることについては、アップローダー を参照してください。

コマンドラインアプリ

#

スクリプトを含むパッケージ(bin/ ディレクトリの下にあるものすべて)については、pubspec ファイルに executables タグを追加することを検討してください。スクリプトが executables にリストされている場合、ユーザーは dart pub global activate を実行して、コマンドラインから直接利用できるようにすることができます。

グローバルオプション

#

いくつかのコマンドラインオプションは、すべての pub サブコマンドで使用できます。これらには以下が含まれます。

--help または -h

#

使用方法に関する情報を表示します。

--trace

#

エラーが発生した場合にデバッグ情報を表示します。

--verbose または -v

#

--verbosity=all と同等です。

--directory=<dir> または -C <dir>

#

指定されたディレクトリでコマンドを実行します。

--[no-]color

#

強調のために出力に色を追加します (--color)。デフォルトは、このコマンドをターミナルで使用しているかどうかによって異なります。ターミナルでは、--color がデフォルトですが、それ以外の場合は --no-color がデフォルトです。すべての環境で色を無効にするには --no-color を使用します。