From 1bc2bb8059c4bc3fbc27268e1745c5f94ac42c7b Mon Sep 17 00:00:00 2001 From: Kynan Ware <47394200+BagToad@users.noreply.github.com> Date: Mon, 18 Nov 2024 16:45:57 -0700 Subject: [PATCH] Improve docs on installing extensions Better clarify the two extension types in the `extension install` docs. Co-authored-by: Tyler McGoffin --- pkg/cmd/extension/command.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index 7ab40b9f1..0030b5078 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -293,12 +293,12 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { Use: "install ", Short: "Install a gh extension from a repository", Long: heredoc.Docf(` - Install a GitHub CLI extension from a GitHub repository. + Install a GitHub CLI extension from a GitHub or local repository. - The repository argument can be specified in %[1]sOWNER/REPO%[1]s format or as a full repository URL. + For GitHub repositories, the repository argument can be specified in %[1]sOWNER/REPO%[1]s format or as a full repository URL. The URL format is useful when the repository is not hosted on github.com. - To install an in-development extension from a locally cloned repository, use %[1]s.%[1]s as the + For local repositories, often used while developing extensions, use %[1]s.%[1]s as the value of the repository argument. Note the following: - After installing an extension from a locally cloned repository, the GitHub CLI will