使用 GitHub CLI 扩展

关于 GitHub CLI 扩展

注意

GitHub 和 GitHub CLI 之外的扩展未获得 GitHub 认证，并受独立的服务条款、隐私政策和支持文档约束。在使用第三方扩展时，为降低风险，请在安装或更新扩展前审查其源代码。

GitHub CLI 扩展是自定义的 GitHub CLI 命令，任何人都可以创建和使用。有关如何创建 GitHub CLI 扩展的更多信息，请参阅创建 GitHub CLI 扩展。

扩展是本地安装的，且仅对当前用户可见。因此，如果您在另一台机器上使用 GitHub CLI，或同一机器上的其他用户使用 GitHub CLI，则该扩展不可用。

您可以通过浏览带有 gh-extension 主题的仓库来查找扩展。

要安装扩展，请使用 extensions install 子命令。将 repo 参数替换为扩展所在的仓库。您可以使用完整的 URL，例如 https://github.com/octocat/gh-whoami，或仅使用所有者和仓库名，例如 octocat/gh-whoami。

如果使用所有者和仓库名，gh 将使用当前已认证的主机名来安装扩展。完整的 URL 形式在从不同主机安装扩展时很有用。例如，GitHub Enterprise Server 的用户应使用完整的仓库 URL 来安装来自 GitHub.com 或其他主机的扩展。

要从当前目录以开发模式安装扩展，请将 repo 参数的值设为 .。

gh extension install REPO

如果已经安装了同名的扩展，命令将会失败。例如，如果您已安装 octocat/gh-whoami，则必须先卸载它，才能安装 hubot/gh-whoami。

安装扩展后，您可以像运行原生 GitHub CLI 命令一样运行该扩展，使用 gh EXTENSION-NAME。其中 EXTENSION-NAME 为包含该扩展的仓库名称，去除前缀 gh-。

例如，如果您从 octocat/gh-whoami 仓库安装了该扩展，则可以使用以下命令运行它。

gh whoami

通常，您可以在包含该扩展的仓库的 README 中找到关于如何使用扩展的具体信息。

要查看所有已安装的扩展，请使用 extensions list 子命令。输出中还会显示哪些扩展有可用更新。

gh extension list

要更新扩展，请使用 extensions upgrade 子命令。将 extension 参数替换为要更新的扩展名称。

gh extension upgrade EXTENSION

要更新所有已安装的扩展，请使用 --all 标志。

gh extension upgrade --all

要卸载扩展，请使用 extensions remove 子命令。将 extension 参数替换为要卸载的扩展名称。

gh extension remove EXTENSION