dotnet tool install

  • [アーティクル]

この記事の対象: ✔️ .NET Core 3.1 SDK 以降のバージョン

名前

dotnet tool install - 指定した .NET ツールをお使いのコンピューターにインストールします。

構文

dotnet tool install <PACKAGE_NAME> -g|--global
    [--allow-downgrade] [-a|--arch <ARCHITECTURE>]
    [--add-source <SOURCE>] [--configfile <FILE>] [--disable-parallel]
    [--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
    [--no-cache] [--prerelease]
    [--tool-manifest <PATH>] [-v|--verbosity <LEVEL>]
    [--version <VERSION_NUMBER>]

dotnet tool install <PACKAGE_NAME> --tool-path <PATH>
    [--allow-downgrade] [-a|--arch <ARCHITECTURE>]
    [--add-source <SOURCE>] [--configfile <FILE>] [--disable-parallel]
    [--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
    [--no-cache] [--prerelease]
    [--tool-manifest <PATH>] [-v|--verbosity <LEVEL>]
    [--version <VERSION_NUMBER>]

dotnet tool install <PACKAGE_NAME> [--local]
    [--allow-downgrade] [-a|--arch <ARCHITECTURE>]
    [--add-source <SOURCE>] [--configfile <FILE>]
    [--create-manifest-if-needed] [--disable-parallel]
    [--framework <FRAMEWORK>] [--ignore-failed-sources] [--interactive]
    [--no-cache] [--prerelease]
    [--tool-manifest <PATH>] [-v|--verbosity <LEVEL>]
    [--version <VERSION_NUMBER>]

dotnet tool install -h|--help

説明

dotnet tool install コマンドを実行すると、.NET ツールがお使いのコンピューターにインストールされます。 コマンドを使用するには、次のいずれかのインストール オプションを指定します。

  • 既定の場所にグローバル ツールをインストールするには、--global オプションを使用します。
  • カスタムの場所にグローバル ツールをインストールするには、--tool-path オプションを使用します。
  • ローカル ツールをインストールするには、--global および --tool-path オプションを省略します。

インストールの場所

グローバル ツール

グローバル ツールは、-g または --global オプションを指定した場合、既定で次のディレクトリにインストールされます。

OS Path
Linux/macOS $HOME/.dotnet/tools
Windows %USERPROFILE%\.dotnet\tools

グローバルにインストールされた各ツールに対して実行可能ファイルがこれらのフォルダーに生成されますが、実際のツール バイナリは兄弟ディレクトリである .store の深くへの入れ子となります。

--tool-path のツール

明示的なツール パスを持つツールは、--tool-path パラメーターが指すように指定した任意の場所に保存されます。 これらは、グローバル ツールと同じ方法で保存されます。つまり、兄弟ディレクトリである .store 内に実際のバイナリを持つ実行可能バイナリです。

ローカル ツール

ローカル ツールは、それが何になるように設定したかに関係なく、NuGet グローバル ディレクトリに保存されます。 $HOME/.dotnet/toolResolverCache 内には各ローカル ツールのための shim ファイルがあり、これはツールがその場所内のどこにあるかを指しています。

ローカル ツールへの参照が、現在のディレクトリ下にある .config ディレクトリ内の dotnet-tools.json ファイルに追加されます。 マニフェスト ファイルがまだ存在しない場合は、--create-manifest-if-needed オプションを使用するか、次のコマンドを実行することで作成します。

dotnet new tool-manifest

詳細については、「ローカル ツールのインストール」を参照してください。

引数

  • PACKAGE_NAME

    インストールする .NET ツールが格納されている NuGet パッケージの名前または ID。

[オプション]

  • --allow-downgrade

    .NET ツール パッケージをインストールまたは更新するときに、パッケージのダウングレードを許可します。 "要求されたバージョン x.x.x が既存のバージョン x.x.x より低い" という警告を抑制します。

  • -a|--arch <ARCHITECTURE>

    ターゲット アーキテクチャを指定します。 これは、ランタイム識別子 (RID) を設定する簡単な構文です。指定した値は、既定の RID と組み合わされます。 たとえば、win-x64 マシンで --arch x86 と指定すると、RID は win-x86 に設定されます。

  • --add-source <SOURCE>

    インストール時に使用するために追加の NuGet パッケージ ソースを追加します。 フィードは、何らかの順番ではなく、並列でアクセスされます。 同じパッケージとバージョンが複数のフィードに存在する場合、最も速いフィードが優先されます。 詳細については、「NuGet パッケージのインストールのしくみ」を参照してください。

  • --configfile <FILE>

    使用する NuGet 構成ファイル (nuget.config)。 指定した場合、このファイルの設定のみが使用されます。 指定しない場合、現在のディレクトリからの構成ファイルの階層が使用されます。 詳細については、「一般的な NuGet 構成」をご覧ください。

  • --create-manifest-if-needed

    ローカル ツールに適用されます。 .NET 8 SDK 以降で使用できます。 マニフェストを見つけるために、検索アルゴリズムは、dotnet-tools.json または dotnet-tools.json ファイルを含む .config フォルダーがないかディレクトリ ツリーを上へと検索していきます。

    ツールマニフェストが見つからず、--create-manifest-if-needed オプションが false に設定されている場合は、CannotFindAManifestFile エラーが発生します。

    ツールマニフェストが見つからず、--create-manifest-if-needed オプションが true に設定されている場合は、ツールはマニフェストを自動的に作成します。 これはマニフェストのフォルダーを次のように選択します。

    • .git サブフォルダーを持つディレクトリを探しながらディレクトリ ツリーを上へと移動していきます。 見つかった場合は、そのディレクトリにマニフェストを作成します。
    • 前の手順でディレクトリが見つからない場合は、ディレクトリ ツリーで、あるディレクトリまたは.gitファイルを.sln検索します。 見つかった場合は、そのディレクトリにマニフェストを作成します。
    • 前の 2 つの手順のいずれでもディレクトリが見つからない場合は、現在の作業ディレクトリにマニフェストを作成します。

    マニフェストの配置方法の詳細については、「ローカル ツールのインストール」を参照してください。

  • --disable-parallel

    複数のプロジェクトを並行して復元できないようにします。

  • --framework <FRAMEWORK>

    ツールをインストールするターゲット フレームワークを指定します。 既定では、.NET SDK によって、最適なターゲット フレームワークの選択が試行されます。

  • -g|--global

    ユーザー全体のインストールを指定します。 --tool-path オプションと組み合わせることはできません。 --global と --tool-path の両方を省略すると、ローカル ツールのインストールが指定されます。

  • -?|-h|--help

    コマンドの使用方法を示した説明を出力します。

  • --ignore-failed-sources

    パッケージ ソース エラーを警告として処理します。

  • --interactive

    コマンドを停止して、ユーザーの入力または操作のために待機させることができます。 たとえば、認証を完了する場合があります。

  • --local

    ツールとローカル ツール マニフェストを更新します。 --global オプションまたは --tool-path オプションと組み合わせることはできません。

  • --no-cache

    パッケージと HTTP 要求はキャッシュしません。

  • --prerelease

    プレリリース パッケージを含めます。

  • --tool-manifest <PATH>

    マニフェスト ファイルへのパス。

  • --tool-path <PATH>

    グローバル ツールをインストールする場所を指定します。 PATH は絶対パスでも相対パスでもかまいません。 PATH が存在しない場合、コマンドではパスの作成を試みます。 --global と --tool-path の両方を省略すると、ローカル ツールのインストールが指定されます。

  • -v|--verbosity <LEVEL>

    コマンドの詳細レベルを設定します。 指定できる値は、q[uiet]、m[inimal]、n[ormal]、d[etailed]、および diag[nostic] です。 詳細については、「LoggerVerbosity」を参照してください。

  • --version <VERSION_NUMBER>

    インストールするツールのバージョン。 既定では、安定した最新バージョンのパッケージがインストールされます。 このオプションを使用して、プレビューまたは古いバージョンのツールをインストールします。

    .NET 8.0 以降、--version Major.Minor.Patch は、リストに記載されていないバージョンを含む、特定の major/minor/patch バージョンを指します。 代わりに、特定の major/minor バージョンの最新バージョンを取得するには、--version Major.Minor.* を使います。

例

  • dotnet tool install -g dotnetsay

    既定の場所に dotnetsay をグローバル ツールとしてインストールします。

  • dotnet tool install dotnetsay --tool-path c:\global-tools

    特定の Windows ディレクトリに dotnetsay をグローバル ツールとしてインストールします。

  • dotnet tool install dotnetsay --tool-path ~/bin

    特定の Linux/macOS ディレクトリに dotnetsay をグローバル ツールとしてインストールします。

  • dotnet tool install -g dotnetsay --version 2.0.0

    バージョン 2.0.0 の dotnetsay をグローバル ツールとしてインストールします。

  • dotnet tool install dotnetsay

    現在のディレクトリに dotnetsay をローカル ツールとしてインストールします。

  • dotnet tool install -g --verbosity minimal

    dotnetsay をグローバル ツールとして、"最小" の詳細度でインストールします。 グローバル ツール向けの既定の詳細度は "静か" です。

関連項目