.NET core グローバル ツールの概要.NET Core Global Tools overview

この記事の対象: ✓ .NET Core 2.1 SDKThis article applies to: ✓ .NET Core 2.1 SDK

.NET Core グローバル ツールは、コンソール アプリケーションを含む特殊な NuGet パッケージです。A .NET Core Global Tool is a special NuGet package that contains a console application. グローバル ツールは、PATH 環境変数に含まれている既定の場所またはカスタムの場所のマシンにインストールできます。A Global Tool can be installed on your machine on a default location that is included in the PATH environment variable or on a custom location.

.NET Core グローバル ツールを使用する場合は、次のことを行います。If you want to use a .NET Core Global Tool:

  • ツールに関する情報を検索します (通常は Web サイトまたは GitHub ページ)。Find information about the tool (usually a website or GitHub page).
  • フィードのホーム (通常は NuGet.org) で作成者と統計情報を確認します。Check the author and statistics in the home for the feed (usually NuGet.org).
  • ツールをインストールします。Install the tool.
  • ツールを呼び出します。Call the tool.
  • ツールを更新します。Update the tool.
  • ツールをアンインストールします。Uninstall the tool.

重要

.NET Core グローバル ツールは、パス上に表示され、完全な信頼で実行されます。.NET Core Global Tools appear on your path and run in full trust. 作成者が信頼できる場合を除き、.NET Core グローバル ツールをインストールしないでください。Do not install .NET Core Global Tools unless you trust the author.

.NET Core グローバル ツールの検索Find a .NET Core Global Tool

現時点では、.NET Core コマンド ライン インターフェイス (CLI) には、グローバル ツールの検索機能はありません。Currently, there isn't a Global Tool search feature in the .NET Core Command-line Interface (CLI). 次に、ツールの検索方法に関する推奨事項をいくつか示します。The following are some recommendations on how to find tools:

  • .NET Core グローバル ツールは、NuGet で見つけることができます。You can find .NET Core Global Tools on NuGet. ただし、NuGet では、具体的に .NET Core グローバル ツールを検索することはまだできません。However, NuGet doesn't yet allow you to search specifically for .NET Core Global Tools.
  • ブログの投稿や natemcmaster/dotnet-tools GitHub リポジトリで、ツールの推奨事項を検索することができます。You may find tool recommendations in blog posts or in the natemcmaster/dotnet-tools GitHub repository.
  • aspnet/DotNetTools GitHub リポジトリでは、ASP.NET チームによって作成されたグローバル ツールのソース コードを確認することができます。You can see the source code for the Global Tools created by the ASP.NET team at the aspnet/DotNetTools GitHub repository.
  • 診断ツールの詳細については、「.NET Core dotnet 診断グローバル ツール」を参照してください。You can learn about diagnostic tools at .NET Core dotnet diagnostic Global Tools.

作成者と統計情報の確認Check the author and statistics

.NET Core グローバル ツールは、完全な信頼で実行され、通常はパス上にインストールされるため、非常に強力です。Since .NET Core Global Tools run in full trust and are generally installed on your path, they can be very powerful. 信頼できないユーザーからツールをダウンロードしないでください。Don't download tools from people you don't trust.

ツールが NuGet でホストされている場合は、ツールを検索することで作成者と統計情報を確認できます。If the tool is hosted on NuGet, you can check the author and statistics by searching for the tool.

グローバル ツールのインストールInstall a Global Tool

グローバル ツールをインストールするには、dotnet tool install .NET Core CLI コマンドを使用します。To install a Global Tool, you use the dotnet tool install .NET Core CLI command. 次の例では、既定の場所にグローバル ツールをインストールする方法を示しています。The following example shows how to install a Global Tool in the default location:

dotnet tool install -g dotnetsay

ツールがインストールできない場合は、エラー メッセージが表示されます。If the tool can't be installed, error messages are displayed. 予定していたフィードがチェックされていることを確認します。Check that the feeds you expected are being checked.

ツールのプレリリース バージョンまたは特定のバージョンをインストールしようとしている場合は、次の形式を使用してバージョン番号を指定できます。If you're trying to install a pre-release version or a specific version of the tool, you can specify the version number using the following format:

dotnet tool install -g <package-name> --version <version-number>

インストールが成功すると、ツールの呼び出しに使用したコマンドとインストールされたバージョンを示す、次の例のようなメッセージが表示されます。If installation is successful, a message is displayed showing the command used to call the tool and the version installed, similar to the following example:

You can invoke the tool using the following command: dotnetsay
Tool 'dotnetsay' (version '2.0.0') was successfully installed.

グローバル ツールは、既定のディレクトリ内または特定の場所にインストールすることができます。Global Tools can be installed in the default directory or in a specific location. 既定のディレクトリは次のとおりです。The default directories are:

OSOS パスPath
Linux/macOSLinux/macOS $HOME/.dotnet/tools
WindowsWindows %USERPROFILE%\.dotnet\tools

これらの場所は、そこにインストールされたグローバル ツールを直接呼び出せるように、SDK が最初に実行されるときにユーザーのパスに追加されます。These locations are added to the user's path when the SDK is first run, so Global Tools installed there can be called directly.

グローバル ツールは、マシン全体ではなく、ユーザーに固有であることに注意してください。Note that the Global Tools are user-specific, not machine global. ユーザーに固有であることは、そのマシンのすべてのユーザーが使用できるグローバル ツールをインストールできないことを意味します。Being user-specific means you cannot install a Global Tool that is available to all users of the machine. このツールは、ツールがインストールされた各ユーザー プロファイルでしか使用できません。The tool is only available for each user profile where the tool was installed.

グローバル ツールは、特定のディレクトリにインストールすることもできます。Global Tools can also be installed in a specific directory. 特定のディレクトリにインストールした場合は、ユーザーはコマンドが使用できることを確認する必要があります。それには、そのディレクトリをパスに含めるか、指定されたディレクトリでコマンドを呼び出すか、指定したディレクトリ内からツールを呼び出します。When installed in a specific directory, the user must ensure the command is available, by including that directory in the path, by calling the command with the directory specified, or calling the tool from within the specified directory. この場合、.NET Core CLI によりこの場所が PATH 環境変数に自動的に追加されることはありません。In this case, the .NET Core CLI doesn't add this location automatically to the PATH environment variable.

ツールの使用Use the tool

ツールをインストールすると、そのコマンドを使用してツールを呼び出すことができます。Once the tool is installed, you can call it by using its command. コマンドが、パッケージ名と異なる場合があることに注意してください。Note that the command may not be the same as the package name.

コマンドが dotnetsay の場合、次を使用して呼び出します。If the command is dotnetsay, you call it with:

dotnetsay

ツールの作成者が dotnet プロンプトのコンテキストにツールを表示するようにした場合は、次のように、dotnet <command> として呼び出す方法でツールを記述している場合があります。If the tool author wanted the tool to appear in the context of the dotnet prompt, they may have written it in a way that you call it as dotnet <command>, such as:

dotnet doc

インストールしたグローバル ツール パッケージに含まれているツールを確認するには、dotnet tool list コマンドを使用してインストールされているパッケージを一覧表示します。You can find which tools are included in an installed Global Tool package by listing the installed packages using the dotnet tool list command.

ツールの使用方法については、ツールの Web サイトで検索するか、次のいずれかのコマンドを入力して検索することもできます。You can also look for usage instructions at the tool's website or by typing one of the following commands:

<command> --help
dotnet <command> --help

その他の CLI コマンドOther CLI commands

.NET Core SDK には、.NET Core グローバル ツールをサポートするその他のコマンドが含まれています。The .NET Core SDK contains other commands that support .NET Core Global Tools. 次のいずれかのオプションを使用して、任意の dotnet tool コマンドを使用します。Use any of the dotnet tool commands with one of the following options:

  • --global または -g は、コマンドがユーザー全体のグローバル ツールに適用可能なことを指定します。--global or -g specifies that the command is applicable to user-wide Global Tools.
  • --tool-path は、グローバル ツールのカスタムの場所を指定します。--tool-path specifies a custom location for Global Tools.

グローバル ツールで使用できるコマンドを調べるには、次のコマンドを使用します。To find out which commands are available for Global Tools:

dotnet tool --help

グローバル ツールを更新するには、ツールをアンインストールしてから、最新の安定バージョンで再インストールする必要があります。Updating a Global Tool involves uninstalling and reinstalling it with the latest stable version. グローバル ツールを更新するには、dotnet tool update コマンドを使用します。To update a Global Tool, use the dotnet tool update command:

dotnet tool update -g <packagename>

dotnet tool uninstall を使用してグローバル ツールを削除します。Remove a Global Tool using the dotnet tool uninstall:

dotnet tool uninstall -g <packagename>

マシンに現在インストールされているすべてのグローバル ツールと、それらのバージョンとコマンドを表示するには、dotnet tool list コマンドを使用します。To display all of the Global Tools currently installed on the machine, along with their version and commands, use the dotnet tool list command:

dotnet tool list -g

関連項目See also