help

package

v3.1.1 Latest Latest Go to latest Published: Jan 18, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Package help print manager and command information on terminal.

go run main.go
go run main.go help
go run main.go help docs

./demo
./demo help
./demo help docs

This section is empty.

This section is empty.

func New() (managers.Command, error)

New function create and return instance.

type Command struct {
	Command managers.Command
	Err     error
	Name    string
}

func (o *Command) Handle(m managers.Manager, a managers.Arguments) error

Handle callable registered on command manager interface.

func (o *Command) HandleCommand(a managers.Arguments, c managers.Command) error

HandleCommand generate command information and print.

func (o *Command) HandleManager(m managers.Manager, a managers.Arguments) error

HandleManager generate manager information and print.

func (o *Command) RenderCommands(m managers.Manager)

RenderCommands print manager command list.

Commands:
  docs         Build application document files
  kv:upload    Collect local config files and upload to consul

func (o *Command) RenderDescription(str string)

RenderDescription print command description information.

func (o *Command) RenderGuider(script string)

RenderGuider print guide information.

func (o *Command) RenderOption(c managers.Command)

RenderOption print option information.

Options:
  -b, --base=string      Specify working base path
      --config=string    Specify config path

func (o *Command) RenderUsage(script, name string)

RenderUsage print usage information.

Usage: ./app COMMAND [OPTION]
Usage: ./app help COMMAND

func (o *Command) RenderVersion()

RenderVersion print version information.

Version: 3.0.0

func (o *Command) SplitWords(w int, str string) []string

SplitWords convert long-text string as multi-rows slice with specified width.