跳至主要内容

使用 GitHub CLI 扩展

了解如何使用其他 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-NAMEEXTENSION-NAME是包含扩展的代码库的名称,减去gh-前缀。

例如,如果您从octocat/gh-whoami代码库安装了扩展,则可以使用以下命令运行扩展:`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