cli

package

v0.11.0 Latest Latest Go to latest Published: May 6, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kukichalang/kukicha

Links

Open Source Insights

Documentation ¶

Index ¶

func Error(msg string)
func Fatal(msg string)
func GetBool(args Args, name string) bool
func GetInt(args Args, name string) (int, error)
func GetRest(args Args, name string) []string
func GetString(args Args, name string) string
func Info(msg string)
func IsJSON(args Args) bool
func IsTTY() bool
func Run(app *App) error
func RunApp(app *App) error
func Success(msg string)
type App
- func Action(app *App, handler func(Args)) *App
- func AddFlag(app *App, name string, description string, defaultValue string) *App
- func Arg(app *App, name string, description string) *App
- func BoolFlag(app *App, name string, desc string, defaultValue bool) *App
- func BoolGlobalFlag(app *App, name string, desc string, defaultValue bool) *App
- func DefaultAction(app *App, handler func(Args)) *App
- func Description(app *App, desc string) *App
- func GlobalFlag(app *App, name string, desc string, defaultValue string) *App
- func IntFlag(app *App, name string, desc string, defaultValue int) *App
- func IntGlobalFlag(app *App, name string, desc string, defaultValue int) *App
- func New(name string) *App
- func RequiredArg(app *App, name string, description string) *App
- func RequiredFlag(app *App, name string, description string) *App
- func RestArg(app *App, name string, description string) *App
- func Short(app *App, alias string) *App
- func StringFlag(app *App, name string, desc string, defaultValue string) *App
- func WithCommands(app *App, cmds ...*SubcommandDef) *App
type ArgDef
type Args
- func NewArgs(values map[string]string) Args
- func ParseArgs(app *App, osArgs []string) Args
- func (args Args) Context() context.Context
- func (args Args) Respond(data any)
type FlagDef
type SubcommandDef
- func NewCommand(name string, desc string) *SubcommandDef
- func (cmd *SubcommandDef) Action(handler func(Args)) *SubcommandDef
- func (cmd *SubcommandDef) Arg(name string, description string) *SubcommandDef
- func (cmd *SubcommandDef) BoolFlag(name string, desc string, defaultValue bool) *SubcommandDef
- func (cmd *SubcommandDef) Flag(name string, desc string, defaultValue string) *SubcommandDef
- func (cmd *SubcommandDef) IntFlag(name string, desc string, defaultValue int) *SubcommandDef
- func (cmd *SubcommandDef) RequiredArg(name string, description string) *SubcommandDef
- func (cmd *SubcommandDef) RequiredFlag(name string, desc string) *SubcommandDef
- func (cmd *SubcommandDef) RestArg(name string, description string) *SubcommandDef
- func (cmd *SubcommandDef) Short(alias string) *SubcommandDef
- func (cmd *SubcommandDef) StringFlag(name string, desc string, defaultValue string) *SubcommandDef
- func (cmd *SubcommandDef) WithCommands(subs ...*SubcommandDef) *SubcommandDef

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Error ¶ added in v0.1.2

func Error(msg string)

func Fatal ¶ added in v0.1.2

func Fatal(msg string)

func GetBool ¶

func GetBool(args Args, name string) bool

func GetInt ¶

func GetInt(args Args, name string) (int, error)

func GetRest ¶ added in v0.11.0

func GetRest(args Args, name string) []string

func GetString ¶

func GetString(args Args, name string) string

func Info ¶ added in v0.1.12

func Info(msg string)

func IsJSON ¶

func IsJSON(args Args) bool

func IsTTY ¶ added in v0.6.1

func IsTTY() bool

func Run ¶ added in v0.6.1

func Run(app *App) error

func RunApp ¶

func RunApp(app *App) error

func Success ¶ added in v0.1.12

func Success(msg string)

Types ¶

type App ¶

type App struct {
	Name          string
	Description   string
	Args          []ArgDef
	Flags         []FlagDef
	GlobalFlags   []FlagDef
	Subcommands   []*SubcommandDef
	ActionFunc    func(Args)
	DefaultAction func(Args)
	RestArgName   string
}

func Action ¶

func Action(app *App, handler func(Args)) *App

func AddFlag ¶

func AddFlag(app *App, name string, description string, defaultValue string) *App

func Arg ¶

func Arg(app *App, name string, description string) *App

func BoolFlag ¶ added in v0.11.0

func BoolFlag(app *App, name string, desc string, defaultValue bool) *App

func BoolGlobalFlag ¶ added in v0.11.0

func BoolGlobalFlag(app *App, name string, desc string, defaultValue bool) *App

func DefaultAction ¶ added in v0.7.2

func DefaultAction(app *App, handler func(Args)) *App

func Description ¶

func Description(app *App, desc string) *App

func GlobalFlag ¶

func GlobalFlag(app *App, name string, desc string, defaultValue string) *App

func IntFlag ¶ added in v0.11.0

func IntFlag(app *App, name string, desc string, defaultValue int) *App

func IntGlobalFlag ¶ added in v0.11.0

func IntGlobalFlag(app *App, name string, desc string, defaultValue int) *App

func New ¶

func New(name string) *App

func RequiredArg ¶ added in v0.7.2

func RequiredArg(app *App, name string, description string) *App

func RequiredFlag ¶ added in v0.7.2

func RequiredFlag(app *App, name string, description string) *App

func RestArg ¶ added in v0.11.0

func RestArg(app *App, name string, description string) *App

func Short ¶ added in v0.11.0

func Short(app *App, alias string) *App

func StringFlag ¶ added in v0.11.0

func StringFlag(app *App, name string, desc string, defaultValue string) *App

func WithCommands ¶ added in v0.6.1

func WithCommands(app *App, cmds ...*SubcommandDef) *App

type ArgDef ¶

type ArgDef struct {
	Name        string
	Description string
	Required    bool
}

type Args ¶

type Args struct {
	// contains filtered or unexported fields
}

func NewArgs ¶

func NewArgs(values map[string]string) Args

func ParseArgs ¶ added in v0.11.0

func ParseArgs(app *App, osArgs []string) Args

func (Args) Context ¶ added in v0.6.1

func (args Args) Context() context.Context

func (Args) Respond ¶ added in v0.6.1

func (args Args) Respond(data any)

type FlagDef ¶

type FlagDef struct {
	Name         string
	Description  string
	DefaultValue string
	Required     bool
	Type         string
	Aliases      []string
}

type SubcommandDef ¶

type SubcommandDef struct {
	Name        string
	Description string
	Args        []ArgDef
	Flags       []FlagDef
	Subcommands []*SubcommandDef
	ActionFunc  func(Args)
	RestArgName string
}

func NewCommand ¶ added in v0.6.1

func NewCommand(name string, desc string) *SubcommandDef

func (*SubcommandDef) Action ¶ added in v0.6.1

func (cmd *SubcommandDef) Action(handler func(Args)) *SubcommandDef

func (*SubcommandDef) Arg ¶ added in v0.6.1

func (cmd *SubcommandDef) Arg(name string, description string) *SubcommandDef

func (*SubcommandDef) BoolFlag ¶ added in v0.11.0

func (cmd *SubcommandDef) BoolFlag(name string, desc string, defaultValue bool) *SubcommandDef

func (*SubcommandDef) Flag ¶ added in v0.6.1

func (cmd *SubcommandDef) Flag(name string, desc string, defaultValue string) *SubcommandDef

func (*SubcommandDef) IntFlag ¶ added in v0.11.0

func (cmd *SubcommandDef) IntFlag(name string, desc string, defaultValue int) *SubcommandDef

func (*SubcommandDef) RequiredArg ¶ added in v0.7.2

func (cmd *SubcommandDef) RequiredArg(name string, description string) *SubcommandDef

func (*SubcommandDef) RequiredFlag ¶ added in v0.7.2

func (cmd *SubcommandDef) RequiredFlag(name string, desc string) *SubcommandDef

func (*SubcommandDef) RestArg ¶ added in v0.11.0

func (cmd *SubcommandDef) RestArg(name string, description string) *SubcommandDef

func (*SubcommandDef) Short ¶ added in v0.11.0

func (cmd *SubcommandDef) Short(alias string) *SubcommandDef

func (*SubcommandDef) StringFlag ¶ added in v0.11.0

func (cmd *SubcommandDef) StringFlag(name string, desc string, defaultValue string) *SubcommandDef

func (*SubcommandDef) WithCommands ¶ added in v0.7.2

func (cmd *SubcommandDef) WithCommands(subs ...*SubcommandDef) *SubcommandDef

Source Files ¶

View all Source files

cli.go

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