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

  • [アーティクル]

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

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

必須コンポーネント

グローバル ツールとしてツールを使用する

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

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

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

    --add-source パラメーターは、NuGet パッケージへの追加のソース フィードとして ./nupkg ディレクトリを一時的に使用するように、.NET CLI に指示します。 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 tool install, --arch option」を参照してください。

  2. ツールを起動します。

    botsay hello from the bot

    注意

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

  3. dotnet tool uninstall コマンドを実行して、ツールを削除します。

    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 tool uninstall コマンドを実行して、ツールを削除します。

    Windows の場合:

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

    Linux または macOS の場合:

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

トラブルシューティング

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

次の手順

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

ローカル ツールをインストールして使用する