charm

Documentation

Overview

Package charm is minimilast CLI framework inspired by cobra and urfave/cli.

Index

• Variables
• func FormatParagraph(body, tab string, lineWidth int) string
• type Command
• type Constructor
• type Spec
  • func (c *Spec) Add(child *Spec)
  • func (s *Spec) Exec(parent Command, args []string) error
  • func (s *Spec) ExecRoot(args []string) error

Variables

var (
	NeedHelp = errors.New("help")
	ErrNoRun = errors.New("no run method")
)

var (
	HelpFlag   = "h"
	HiddenFlag = "hidden"
)

Functions

func FormatParagraph

func FormatParagraph(body, tab string, lineWidth int) string

Types

type Command

type Command interface {
	Run([]string) error
}

type Constructor

type Constructor func(Command, *flag.FlagSet) (Command, error)

type Spec

type Spec struct {
	Name  string
	Usage string
	Short string
	Long  string
	New   Constructor
	// Hidden hides this command from help.
	Hidden bool
	// Hidden flags (comma-separated) marks these flags as hidden.
	HiddenFlags string
	// Redacted flags (comma-separated) marks these flags as redacted,
	// where a flag is shown (if not hidden) but its default value is hidden,
	// e.g., as is useful for a password flag.
	RedactedFlags string
	// contains filtered or unexported fields
}

func (*Spec) Add

func (c *Spec) Add(child *Spec)

func (*Spec) Exec

func (s *Spec) Exec(parent Command, args []string) error

func (*Spec) ExecRoot

func (s *Spec) ExecRoot(args []string) error