package cli import ( "fmt" "io" ) // The text template for the Default help topic. // cli.go uses text/template to render templates. You can // render custom help text by setting this variable. var AppHelpTemplate = `NAME: {{.Name}} - {{.Usage}} USAGE: {{.Name}} [global options] command [command options] [arguments...] VERSION: {{.Version}} COMMANDS: {{range .Commands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}} {{end}} GLOBAL OPTIONS: {{range .Flags}}{{.}} {{end}} ` // The text template for the command help topic. // cli.go uses text/template to render templates. You can // render custom help text by setting this variable. var CommandHelpTemplate = `NAME: {{.Name}} - {{.Usage}} USAGE: command {{.Name}} [command options] [arguments...] DESCRIPTION: {{.Description}} OPTIONS: {{range .Flags}}{{.}} {{end}} ` // The text template for the subcommand help topic. // cli.go uses text/template to render templates. You can // render custom help text by setting this variable. var SubcommandHelpTemplate = `NAME: {{.Name}} - {{.Usage}} USAGE: {{.Name}} [global options] command [command options] [arguments...] COMMANDS: {{range .Commands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}} {{end}} OPTIONS: {{range .Flags}}{{.}} {{end}} ` var helpCommand = Command{ Name: "help", ShortName: "h", Usage: "Shows a list of commands or help for one command", Action: func(c *Context) { args := c.Args() if args.Present() { ShowCommandHelp(c, args.First()) } else { ShowAppHelp(c) } }, } var helpSubcommand = Command{ Name: "help", ShortName: "h", Usage: "Shows a list of commands or help for one command", Action: func(c *Context) { args := c.Args() if args.Present() { ShowCommandHelp(c, args.First()) } else { ShowSubcommandHelp(c) } }, } // Prints help for the App type helpPrinter func(templ string, data interface{}) var HelpPrinter helpPrinter = nil func ShowAppHelp(c *Context) { HelpPrinter(AppHelpTemplate, c.App) } // Prints the list of subcommands as the default app completion method func DefaultAppComplete(c *Context) { for _, command := range c.App.Commands { io.WriteString(c.App.Writer, fmt.Sprintln(command.Name)) if command.ShortName != "" { io.WriteString(c.App.Writer, fmt.Sprintln(command.ShortName)) } } } // Prints help for the given command func ShowCommandHelp(c *Context, command string) { for _, c := range c.App.Commands { if c.HasName(command) { HelpPrinter(CommandHelpTemplate, c) return } } if c.App.CommandNotFound != nil { c.App.CommandNotFound(c, command) } else { io.WriteString(c.App.Writer, fmt.Sprintf("No help topic for '%v'\n", command)) } } // Prints help for the given subcommand func ShowSubcommandHelp(c *Context) { HelpPrinter(SubcommandHelpTemplate, c.App) } // Prints the version number of the App func ShowVersion(c *Context) { io.WriteString(c.App.Writer, fmt.Sprintf("%v version %v\n", c.App.Name, c.App.Version)) } // Prints the lists of commands within a given context func ShowCompletions(c *Context) { a := c.App if a != nil && a.BashComplete != nil { a.BashComplete(c) } } // Prints the custom completions for a given command func ShowCommandCompletions(ctx *Context, command string) { c := ctx.App.Command(command) if c != nil && c.BashComplete != nil { c.BashComplete(ctx) } } func checkVersion(c *Context) bool { if c.GlobalBool("version") { ShowVersion(c) return true } return false } func checkHelp(c *Context) bool { if c.GlobalBool("h") || c.GlobalBool("help") { ShowAppHelp(c) return true } return false } func checkCommandHelp(c *Context, name string) bool { if c.Bool("h") || c.Bool("help") { ShowCommandHelp(c, name) return true } return false } func checkSubcommandHelp(c *Context) bool { if c.GlobalBool("h") || c.GlobalBool("help") { ShowSubcommandHelp(c) return true } return false } func checkCompletions(c *Context) bool { if c.GlobalBool(BashCompletionFlag.Name) && c.App.EnableBashCompletion { ShowCompletions(c) return true } return false } func checkCommandCompletions(c *Context, name string) bool { if c.Bool(BashCompletionFlag.Name) && c.App.EnableBashCompletion { ShowCommandCompletions(c, name) return true } return false }