教程:使用 .NET CLI 安装和使用 .NET 全局工具

本文适用于: ✔️ .NET Core 2.1 SDK 及更高版本

本教程介绍如何安装和使用全局工具。 使用在本系列的第一个教程中创建的工具。

先决条件

使用该工具作为全局工具

  1. 通过运行 microsoft.botsay 项目文件夹中的 dotnet tool install 命令,从包中安装该工具 :

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

    --global 参数指示 .NET CLI 将工具二进制文件安装在自动添加到 PATH 环境变量的默认位置中。

    --add-source 参数指示 .NET CLI 临时使用 ./nupkg 目录作为 NuGet 包的附加源数据源。 为包提供了唯一名称,以确保它仅位于 ./nupkg 目录中,而不是在 Nuget.org 站点上。

    输出显示用于调用该工具和已安装的版本的命令:

    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 工具使用问题

后续步骤

在本教程中,已将工具作为全局工具安装和使用。 有关如何安装和使用全局工具的详细信息,请参阅管理全局工具。 若要安装和使用与本地工具相同的工具,请转到下一教程。