Skip to content

Commit 2a2088d

Browse files
committed
💅 tweak extension docs
1 parent 28cbfc4 commit 2a2088d

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

pkg/cmd/extension/command.go

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
3030
will be forwarded to the %[1]sgh-<extname>%[1]s executable of the extension.
3131
3232
An extension cannot override any of the core gh commands.
33+
34+
See the list of available extensions at <https://github.com/topics/gh-extension>
3335
`, "`"),
3436
Aliases: []string{"extensions"},
3537
}
@@ -67,23 +69,25 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command {
6769
},
6870
},
6971
&cobra.Command{
70-
Use: "install <repo>",
72+
Use: "install <repository>",
7173
Short: "Install a gh extension from a repository",
7274
Long: heredoc.Doc(`
73-
GitHub CLI extensions are installed from a repository.
75+
Install a GitHub repository locally as a GitHub CLI extension.
7476
75-
The <repo> argument accepts the short form of the repo ("owner/repo") or the
76-
full repository URL. If the full repository URL is not used, gh will install
77-
the extension using the hostname to which gh is currently authenticated.
77+
The repository argument can be specified in "owner/repo" format as well as a full URL.
78+
The URL format is useful when the repository is not hosted on github.com.
7879
79-
Using the full repository URL allows GitHub Enterprise users to install
80-
extensions from public GitHub.
80+
To install an extension in development from the current directory, use "." as the
81+
value of the repository argument.
8182
82-
Examples:
83-
gh extension install owner/repo
84-
gh extension install https://github.com/owner/repo
83+
See the list of available extensions at <https://github.com/topics/gh-extension>
84+
`),
85+
Example: heredoc.Doc(`
86+
$ gh extension install owner/gh-extension
87+
$ gh extension install https://git.example.com/owner/gh-extension
88+
$ gh extension install .
8589
`),
86-
Args: cmdutil.MinimumArgs(1, "must specify a repository to install from"),
90+
Args: cmdutil.MinimumArgs(1, "must specify a repository to install from"),
8791
RunE: func(cmd *cobra.Command, args []string) error {
8892
if args[0] == "." {
8993
wd, err := os.Getwd()

0 commit comments

Comments
 (0)