cli

Documentation

Index

• type App
  • func Parse(args []string) (*App, error)
  • func (a *App) CLI() *CLI
  • func (a *App) PrintHelp(p *core.Printer)
• type Arguments
• type CLI
• type Flag
• type MissingEnvVarError
  • func (err *MissingEnvVarError) Error() string
  • func (err *MissingEnvVarError) PrintTo(p *core.Printer)

Types

type App

type App struct {
	URL       *url.URL
	ExtraArgs []string

	Cfg config.Config

	AWSSigv4   *aws.Config
	Basic      *core.KeyVal
	Bearer     string
	BuildInfo  bool
	Complete   string
	ConfigPath string
	Data       io.Reader
	DryRun     bool
	Edit       bool
	Form       []core.KeyVal
	Help       bool
	JSON       io.Reader
	Method     string
	Multipart  []core.KeyVal
	Output     string
	OutputDir  bool
	Range      []string
	UnixSocket string
	Update     bool
	Version    bool
	XML        io.Reader
}

App represents the full configuration for a fetch invocation.

func Parse

func Parse(args []string) (*App, error)

func (*App) CLI

func (a *App) CLI() *CLI

func (*App) PrintHelp

func (a *App) PrintHelp(p *core.Printer)

type Arguments

type Arguments struct {
	Name        string
	Description string
}

type CLI

type CLI struct {
	Description    string
	ArgFn          func(s string) error
	Args           []Arguments
	Flags          []Flag
	ExclusiveFlags [][]string
}

type Flag

type Flag struct {
	Short       string
	Long        string
	Aliases     []string
	Args        string
	Description string
	Default     string
	Values      []core.KeyVal
	HideValues  bool
	IsHidden    bool
	IsSet       func() bool
	OS          []string
	Fn          func(value string) error
}

type MissingEnvVarError

type MissingEnvVarError struct {
	EnvVar string
	Flag   string
}

func (*MissingEnvVarError) Error

func (err *MissingEnvVarError) Error() string

func (*MissingEnvVarError) PrintTo

func (err *MissingEnvVarError) PrintTo(p *core.Printer)