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

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

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

[前提条件]

• このシリーズの最初のチュートリアルを完了します。
• .NET 10.0.100 SDK 以降 ( dnxの場合) - 省略可能ですが、推奨されます。

インストールなしでツールを実行する (推奨)

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

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

   dnx microsoft.botsay --add-source ./nupkg microsoft.botsay hello from the bot
   

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

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

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

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

   dotnet tool install --global --add-source ./nupkg microsoft.botsay
   

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

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

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

   You can invoke the tool using the following command: botsay
   Tool 'microsoft.botsay' (version '1.0.0') was successfully installed.
   

   注

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

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

   botsay hello from the bot
   

   注

   このコマンドが失敗した場合は、PATH を更新するために新しいターミナルを開く必要があります。

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

   dotnet tool uninstall -g microsoft.botsay
   

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

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

   Windows の場合:

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

   Linux または macOS の場合:

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

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

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

   You can invoke the tool using the following command: botsay
   Tool 'microsoft.botsay' (version '1.0.0') was successfully installed.
   

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

   Windows の場合:

   c:\dotnet-tools\botsay hello from the bot
   

   Linux または macOS の場合:

   ~/bin/botsay hello from the bot
   

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

   Windows の場合:

   dotnet tool uninstall --tool-path c:\dotnet-tools microsoft.botsay
   

   Linux または macOS の場合:

   dotnet tool uninstall --tool-path ~/bin microsoft.botsay
   

Troubleshoot

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

次のステップ

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