The Wayback Machine - https://web.archive.org/web/20210825150842/https://docs.github.com/en/github-cli/github-cli/using-github-cli-extensions

Using GitHub CLI extensions

Learn how to use custom extensions written by other GitHub CLI users.

About GitHub CLI extensions

Note: Extensions outside of GitHub and GitHub CLI are not certified by GitHub and are governed by separate terms of service, privacy policy, and support documentation. To mitigate risk when using third-party extensions, audit the source code of the extension before installing or updating the extension.

GitHub CLI extensions are custom GitHub CLI commands that anyone can create and use. For more information about how to create GitHub CLI extensions, see "Creating GitHub CLI extensions."

Extensions are locally installed and are scoped to the user. Therefore, if you access GitHub CLI from a different machine or another user accesses GitHub CLI from the same machine, the extension will not be available.

Finding extensions

You can find extensions by browsing repositories with the gh-extension topic.

Installing extensions

To install an extension, use the extensions install subcommand. Replace the owner/repo parameter with the name of the extension, such as octocat/gh-whoami.

gh extension install owner/repo

If you already have an extension by the same name installed, the command will fail. For example, if you have installed octocat/gh-whoami, you must uninstall it before installing hubot/gh-whoami.

Viewing installed extensions

To view all installed extensions, use the extensions list subcommand. The output will also tell you which extensions have updates available.

gh extension list

Updating extensions

To update an extension, use the extensions upgrade subcommand. Replace the extension parameter with the name of the extension.

gh extension upgrade extension

To update all installed extensions, use the --all flag.

gh extension upgrade --all

Uninstalling extensions

To uninstall an extension, use the extensions remove subcommand. Replace the extension parameter with the name of the extension.

gh extension remove extension

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.