diff --git a/command.go b/command.go index 43091875..5ff32ea7 100644 --- a/command.go +++ b/command.go @@ -40,6 +40,8 @@ type Command struct { Short string // The long message shown in the 'help ' output. Long string + // Examples of how to use the command + Example string // Full set of flags flags *flag.FlagSet // Set of flags childrens of this command will inherit @@ -206,8 +208,11 @@ Usage: {{if .Runnable}} {{ .CommandPath}} [command]{{end}}{{if gt .Aliases 0}} Aliases: - {{.NameAndAliases}}{{end}} -{{ if .HasSubCommands}} + {{.NameAndAliases}} +{{end}}{{if .HasExample}} +Examples: +{{ .Example }} +{{end}}{{ if .HasSubCommands}} Available Commands: {{range .Commands}}{{if .Runnable}} {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}} {{end}} @@ -684,6 +689,10 @@ func (c *Command) NameAndAliases() string { return strings.Join(append([]string{c.Name()}, c.Aliases...), ", ") } +func (c *Command) HasExample() bool { + return len(c.Example) > 0 +} + // Determine if the command is itself runnable func (c *Command) Runnable() bool { return c.Run != nil