65 lines
2 KiB
Go
65 lines
2 KiB
Go
package root
|
|
|
|
import (
|
|
"github.com/MakeNowJust/heredoc"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func NewHelpTopic(topic string) *cobra.Command {
|
|
topicContent := make(map[string]string)
|
|
|
|
topicContent["environment"] = heredoc.Doc(`
|
|
GITHUB_TOKEN: an authentication token for github.com API requests. Setting this avoids
|
|
being prompted to authenticate and takes precedence over previously stored credentials.
|
|
|
|
GITHUB_ENTERPRISE_TOKEN: an authentication token for API requests to GitHub Enterprise.
|
|
|
|
GH_REPO: specify the GitHub repository in the "[HOST/]OWNER/REPO" format for commands
|
|
that otherwise operate on a local repository.
|
|
|
|
GH_HOST: specify the GitHub hostname for commands that would otherwise assume
|
|
the "github.com" host when not in a context of an existing repository.
|
|
|
|
GH_EDITOR, GIT_EDITOR, VISUAL, EDITOR (in order of precedence): the editor tool to use
|
|
for authoring text.
|
|
|
|
BROWSER: the web browser to use for opening links.
|
|
|
|
DEBUG: set to any value to enable verbose output to standard error. Include values "api"
|
|
or "oauth" to print detailed information about HTTP requests or authentication flow.
|
|
|
|
PAGER: a terminal paging program to send standard output to, e.g. "less".
|
|
|
|
GLAMOUR_STYLE: the style to use for rendering Markdown. See
|
|
https://github.com/charmbracelet/glamour#styles
|
|
|
|
NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output.
|
|
|
|
CLICOLOR: set to "0" to disable printing ANSI colors in output.
|
|
|
|
CLICOLOR_FORCE: set to a value other than "0" to keep ANSI colors in output
|
|
even when the output is piped.
|
|
`)
|
|
|
|
cmd := &cobra.Command{
|
|
Use: topic,
|
|
Long: topicContent[topic],
|
|
Hidden: true,
|
|
Args: cobra.NoArgs,
|
|
Run: helpTopicHelpFunc,
|
|
}
|
|
|
|
cmd.SetHelpFunc(helpTopicHelpFunc)
|
|
cmd.SetUsageFunc(helpTopicUsageFunc)
|
|
|
|
return cmd
|
|
}
|
|
|
|
func helpTopicHelpFunc(command *cobra.Command, args []string) {
|
|
command.Print(command.Long)
|
|
}
|
|
|
|
func helpTopicUsageFunc(command *cobra.Command) error {
|
|
command.Printf("Usage: gh help %s", command.Use)
|
|
return nil
|
|
}
|