チュートリアル: .NET CLI を使用して .NET グローバル ツールをインストールして使用する

この記事は、.NET 8 SDK 以降のバージョンに適用されます: ✔️

このチュートリアルでは、グローバル ツールをインストールして使用する方法について説明します。 使用するツールは、 このシリーズの最初のチュートリアルで作成するツールです。

[前提条件]

.NET 10.0.100 以降では、 dnxを使用して、永続的なインストールなしで .NET ツールを実行できます。

  1. dnx (簡略化された構文) を使用してツールを直接実行します。

    dnx dotnet-env --add-source ./nupkg
    

    --add-source パラメーターは、ツールが NuGet.org で使用できない場合に nuGet パッケージの追加ソース フィードとして ./nupkg ディレクトリを使用するように.NET CLI に指示します。

ツールをグローバル ツールとして使用する (従来のインストール)

頻繁に使用するために永続的なインストールを使用する場合:

  1. dotnet-env プロジェクト フォルダーで dotnet tool install コマンドを実行して、パッケージからツールをインストールします。

    dotnet tool install --global --add-source ./nupkg dotnet-env
    

    --global パラメーターは、PATH 環境変数に自動的に追加される既定の場所にツール バイナリをインストールするように、.NET CLI に指示します。

    --add-source パラメーターは、.NET CLI に対して、NuGet パッケージの追加のソース フィードとして ./nupkg ディレクトリを一時的に使用するように指示します。 パッケージに一意の名前を付けて、NuGet.org ではなく 、./nupkg ディレクトリにのみ見つかるようにしました。

    出力には、ツールの呼び出しに使用したコマンドと、インストールされているバージョンが表示されます。

    You can invoke the tool using the following command: dotnet-env
    Tool 'dotnet-env' (version '1.0.0') was successfully installed.
    

    既定では、インストールする .NET バイナリのアーキテクチャは、現在実行中の OS アーキテクチャを表します。 別の OS アーキテクチャを指定するには、 dotnet ツールのインストール、--arch オプションを参照してください。

  2. ツールを呼び出します。

    dotnet-env
    

    コマンドが失敗した場合は、新しいターミナルを開き、 PATH 環境変数を更新します。

  3. dotnet ツールのアンインストール コマンドを実行して 、ツールを削除 します。

    dotnet tool uninstall -g dotnet-env
    

カスタムの場所にインストールされているグローバル ツールとしてツールを使用する

  1. パッケージからツールをインストールします。

    Windows の場合:

    dotnet tool install --tool-path c:\dotnet-tools --add-source ./nupkg dotnet-env
    

    Linux または macOS の場合:

    dotnet tool install --tool-path ~/bin --add-source ./nupkg dotnet-env
    

    --tool-path パラメーターは、指定した場所にツール バイナリをインストールするように .NET CLI に指示します。 ディレクトリが存在しない場合は、作成されます。 ディレクトリは、 PATH 環境変数に自動的に追加されません。

    出力には、ツールの呼び出しに使用したコマンドと、インストールされているバージョンが表示されます。

    You can invoke the tool using the following command: dotnet-env
    Tool 'dotnet-env' (version '1.0.0') was successfully installed.
    
  2. ツールを呼び出します。

    Windows の場合:

    c:\dotnet-tools\dotnet-env
    

    Linux または macOS の場合:

    ~/bin/dotnet-env
    
  3. dotnet ツールのアンインストール コマンドを実行して 、ツールを削除 します。

    Windows の場合:

    dotnet tool uninstall --tool-path c:\dotnet-tools dotnet-env
    

    Linux または macOS の場合:

    dotnet tool uninstall --tool-path ~/bin dotnet-env
    

Troubleshoot

チュートリアルの実行中にエラー メッセージが表示される場合は、「 .NET ツールの使用に関する問題のトラブルシューティング」を参照してください。

次のステップ

このチュートリアルでは、ツールをグローバル ツールとしてインストールして使用しました。 グローバル ツールのインストールと使用の詳細については、「 グローバル ツールの管理」を参照してください。 ローカル ツールと同じツールをインストールして使用するには、次のチュートリアルに進みます。