templates

package

v0.0.0-...-46800f1 Latest Latest Go to latest Published: May 11, 2022 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/elqx/eloquactl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ActsAsRootCommand(cmd *cobra.Command, groups ...CommandGroup)
func Examples(s string) string
func HelpTemplate() string
func LongDesc(s string) string
func UsageTemplate() string
type CommandGroup
type CommandGroups
- func (g CommandGroups) AddTo(c *cobra.Command)

Constants ¶

View Source

const (
	SectionAliases = `{{if gt (len .Aliases) 0}}Aliases:
{{.NameAndAliases}}

{{end}}`

	SectionExamples = `{{if .HasExample}}Examples:
{{trimRight .Example}}

{{end}}`

	SectionSubcommands = `{{if .HasAvailableSubCommands}}{{cmdGroupsString .}}

{{end}}`

	SectionFlags = `{{if .HasLocalFlags}}Options:
{{flagsUsages .LocalFlags}}
{{end}}`
)

View Source

const Indentation = `  `

Variables ¶

This section is empty.

Functions ¶

func ActsAsRootCommand ¶

func ActsAsRootCommand(cmd *cobra.Command, groups ...CommandGroup)

func Examples ¶

func Examples(s string) string

Examples normalizes a command's examples to follow the conventions.

func HelpTemplate ¶

func HelpTemplate() string

template for help command

func LongDesc ¶

func LongDesc(s string) string

func UsageTemplate ¶

func UsageTemplate() string

command usage template

Types ¶

type CommandGroup ¶

type CommandGroup struct {
	Message  string
	Commands []*cobra.Command
}

type CommandGroups ¶

type CommandGroups []CommandGroup

func (CommandGroups) AddTo ¶

func (g CommandGroups) AddTo(c *cobra.Command)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL