Skip to content

Commit 8dbcbdd

Browse files
authored
Add info on how to run GitHub CLI extensions (#48547)
1 parent 173abd1 commit 8dbcbdd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

content/github-cli/github-cli/using-github-cli-extensions.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,18 @@ gh extension install REPO
4040

4141
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`.
4242

43+
## Running an extension
44+
45+
When you have installed an extension, you run the extension as you would run a native {% data variables.product.prodname_cli %} command, using `gh EXTENSION-NAME`. The `EXTENSION-NAME` is the name of the repository that contains the extension, minus the `gh-` prefix.
46+
47+
For example, if you installed the extension from the `octocat/gh-whoami` repository, you would run the extension with the following command.
48+
49+
``` shell
50+
gh whoami
51+
```
52+
53+
You can usually find specific information about how to use an extension in the README of the repository that contains the extension.
54+
4355
## Viewing installed extensions
4456

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

0 commit comments

Comments
 (0)