cli

package module

Go to main page

Versions in this module

v0

v0.32.8

Nov 15, 2024

v0.32.7

Nov 15, 2024

v0.32.6

Nov 15, 2024

v0.32.5

Nov 15, 2024

v0.32.4

Nov 13, 2024

v0.32.3

Nov 13, 2024

Changes in this version

type Tmux

+ func (t Tmux) NewDetachedSessionCommand(session string) string

v0.32.2

Nov 12, 2024

Changes in this version

type Command

+ func (c *Command) VisibleSubcommandsCount() int

v0.32.1

Nov 11, 2024

Changes in this version

type Tmux

+ func (t Tmux) CreateSplitWindowCommand(session string, window string, keys []string) string

v0.32.0

Nov 11, 2024

Changes in this version

type IO

+ func (io *IO) Tmux() Tmux

+ type Tmux struct

+ func (t *Tmux) AttachSessionCommand(session string) string

+ func (t *Tmux) NewSessionCommand(session string, detached bool) string

+ func (t *Tmux) NewWindowCommand(session string, window string) string

+ func (t *Tmux) RenameWindowCommand(session string, window string, name string) string

+ func (t *Tmux) SelectPaneCommand(session string, window string, pane int) string

+ func (t *Tmux) SelectWindowCommand(session string, window string) string

+ func (t *Tmux) SendKeysCommand(session string, window string, keys string) string

+ func (t *Tmux) SendKeysToPaneCommand(session string, window string, pane int, keys string) string

+ func (t *Tmux) SessionExists(session string) bool

+ func (t *Tmux) SplitWindowHorizontallyCommand(session string, window string) string

+ func (t *Tmux) SplitWindowVerticallyCommand(session string, window string) string

+ func (t Tmux) Exec(cmd string) error

+ func (t Tmux) ExecMultiple(cmds []string) error

+ func (t Tmux) KillSessionCommand(session string) string

+ func (t Tmux) KillWindowCommand(session string, window string) string

v0.31.0

Nov 8, 2024

v0.30.0

Nov 8, 2024

v0.29.2

Oct 23, 2024

v0.29.1

Oct 21, 2024

Changes in this version

type Input

+ func (i *Input) FlagProvided(name string) bool

v0.29.0

Oct 21, 2024

v0.28.0

Oct 21, 2024

Changes in this version

type ArrayFlag

+ Options []string

+ func (f *ArrayFlag) Opts() []string

+ type HasOptions interface

+ Opts func() []string

type InputInspector

+ func (i InputInspector) FlagIsGiven(flag Flag) bool

+ func (i InputInspector) String() string

type OptionalArrayFlag

+ Options []string

+ func (f *OptionalArrayFlag) Opts() []string

type OptionalStringFlag

+ Options []string

+ func (f *OptionalStringFlag) Opts() []string

type StringFlag

+ Options []string

+ func (f *StringFlag) Opts() []string

v0.27.0

Oct 18, 2024

Changes in this version

+ const ShellCompRequestCmd

+ func CheckErr(msg any)

+ func CompError(msg string)

+ func CompErrorln(msg string)

+ func WriteStringAndCheck(b io.StringWriter, s string)

type Command

+ func (c *Command) Arg(name string) (Arg, error)

+ func (c *Command) Flag(name string) (Flag, error)

+ func (c *Command) GenZshCompletion(w io.Writer) error

+ func (c *Command) InitDefaultCompletionCmd(out *os.File)

+ func (c *Command) Subcommands() map[string]*Command

type IO

+ func (io *IO) Table(headers []string, rows [][]*TableCell, options *TableOptions)

+ func (io *IO) TableFromMap(headers []string, rows []map[string]any, options *TableOptions)

+ func (io *IO) TableFromSlices(headers []string, rows [][]any, options *TableOptions)

type Input

+ func (i *Input) Inspect(tokens []string) (InputInspector, error)

+ type InputInspector struct

+ Args []string

+ Flags map[string][]string

+ func (i *InputInspector) AddArg(value string)

+ func (i *InputInspector) AddFlag(name string, value string)

+ func (i InputInspector) ArgsCount() int

+ func (i InputInspector) FlagsCount() int

+ type ShellCompDirective int

+ const ShellCompDirectiveDefault

+ const ShellCompDirectiveError

+ const ShellCompDirectiveFilterDirs

+ const ShellCompDirectiveFilterFileExt

+ const ShellCompDirectiveKeepOrder

+ const ShellCompDirectiveNoFileComp

+ const ShellCompDirectiveNoSpace

v0.26.2

Oct 14, 2024

v0.26.1

Oct 14, 2024

v0.26.0

Oct 14, 2024

Changes in this version

type Command

+ CascadeNativeFlags bool

+ PromptForCommand bool

+ func (c *Command) Root() *Command

type IO

+ Command *Command

v0.25.0

Oct 9, 2024

Changes in this version

type Command

+ NativeFlags []string

v0.24.3

Oct 9, 2024

Changes in this version

type Arg

+ Opts func() []string

type ArrayArg

+ func (a *ArrayArg) Opts() []string

type StringArg

+ func (a *StringArg) Opts() []string

v0.24.2

Oct 9, 2024

Changes in this version

+ const ColorBlack

+ const ColorBlue

+ const ColorBrightBlue

+ const ColorBrightCyan

+ const ColorBrightGreen

+ const ColorBrightMagenta

+ const ColorBrightRed

+ const ColorBrightWhite

+ const ColorBrightYellow

+ const ColorCyan

+ const ColorDefault

+ const ColorGray

+ const ColorGreen

+ const ColorMagenta

+ const ColorOptionBlink

+ const ColorOptionBold

+ const ColorOptionConceal

+ const ColorOptionItalic

+ const ColorOptionReverse

+ const ColorOptionUnderscore

+ const ColorRed

+ const ColorWhite

+ const ColorYellow

+ const LogTagAlert

+ const LogTagCritical

+ const LogTagDebug

+ const LogTagError

+ const LogTagFatal

+ const LogTagInfo

+ const LogTagNotice

+ const LogTagWarn

v0.24.1

Sep 26, 2024

Changes in this version

+ type MultiSelectOptions interface

+ type MultiSelectPrompt struct

+ Hint string

+ Label string

+ func NewMultiSelectPrompt(i *Input, o *Output, label string, options MultiSelectOptions, ...) *MultiSelectPrompt

+ func (p *MultiSelectPrompt) IsHighlighted(value string) bool

+ func (p *MultiSelectPrompt) IsSelected(value string) bool

+ func (p *MultiSelectPrompt) Render() ([]string, error)

+ func (p *MultiSelectPrompt) SelectedLabels() []string

+ func (p *MultiSelectPrompt) SetRequired()

+ func (p *MultiSelectPrompt) View() string

+ func (p *MultiSelectPrompt) Visible() []string

v0.24.0

Sep 26, 2024

Changes in this version

type IO

+ func (io *IO) MultiSelect(label string, options MultiSelectOptions, defaultValues []string) ([]string, error)

type Output

+ func (o *Output) MultiSelect(label string, options MultiSelectOptions, defaultValues []string) ([]string, error)

type Theme

+ LogFormatter logFormatter

v0.23.0

Sep 26, 2024

Changes in this version

type Command

+ func (c *Command) Exit(err error)

type IO

+ func (io *IO) Search(label string, options func(string) SearchResult, placeholder string) (string, error)

type Output

+ func (o *Output) Search(label string, options func(string) SearchResult, placeholder string) (string, error)

+ type SearchPrompt struct

+ Hint string

+ Label string

+ Options func(string) SearchResult

+ Placeholder string

+ func NewSearchPrompt(i *Input, o *Output, label string, options func(string) SearchResult, ...) *SearchPrompt

+ func (p *SearchPrompt) Matches() []string

+ func (p *SearchPrompt) Render() (string, error)

+ func (p *SearchPrompt) SearchValue() string

+ func (p *SearchPrompt) SelectedLabel() string

+ func (p *SearchPrompt) ValueWithCursor(maxWidth int) string

+ func (p *SearchPrompt) ValueWithCursorAndSearchcon(maxWidth int) string

+ func (p *SearchPrompt) View() string

+ func (p *SearchPrompt) Visible() []string

+ type SearchResult interface

v0.22.4

Sep 25, 2024

v0.22.3

Sep 25, 2024

v0.22.2

Sep 24, 2024

v0.22.1

Sep 24, 2024

Changes in this version

type Spinner

+ KeepRenderedLines bool

v0.22.0

Sep 23, 2024

Changes in this version

type ArrayFlag

+ func (f *ArrayFlag) WasGiven() bool

type BoolFlag

+ func (f *BoolFlag) WasGiven() bool

type Command

+ AutoExit bool

+ CatchErrors bool

+ Commands []*Command

+ LongVersion string

+ PrintHelpFunc func(o *Output, command *Command)

+ Strict bool

+ Version string

+ func (c *Command) AddCommand(command *Command)

+ func (c *Command) All() map[string]*Command

+ func (c *Command) FullName() string

+ func (c *Command) GetHelp() string

+ func (c *Command) HasSubcommands() bool

+ func (c *Command) Namespace() string

+ func (c *Command) Parent() *Command

+ func (c *Command) RenderError(o *Output, err error)

+ func (c *Command) SetParent(parent *Command)

+ func (c *Command) Subcommand(name string) *Command

type Flag

+ WasGiven func() bool

+ type IO struct

+ Args []string

+ Input *Input

+ Output *Output

+ func (io *IO) Alert(messages ...string)

+ func (io *IO) Array(name string) []string

+ func (io *IO) Ask(question string, defaultValue string) (string, error)

+ func (io *IO) Bool(name string) bool

+ func (io *IO) ChildProcess(cmd string) *ChildProcess

+ func (io *IO) Choice(question string, choices map[string]string, defaultValue string) (string, error)

+ func (io *IO) Comment(messages ...string)

+ func (io *IO) Confirm(question string, defaultValue bool) (bool, error)

+ func (io *IO) Err(err error)

+ func (io *IO) Error(messages ...string)

+ func (io *IO) Exec(cmd string, shell string, inherit bool) (string, error)

+ func (io *IO) Info(messages ...string)

+ func (io *IO) IsDebug() bool

+ func (io *IO) IsDecorated() bool

+ func (io *IO) IsQuiet() bool

+ func (io *IO) IsVerbose() bool

+ func (io *IO) IsVeryVerbose() bool

+ func (io *IO) NewLine(count uint)

+ func (io *IO) Note(messages ...string)

+ func (io *IO) Ok(messages ...string)

+ func (io *IO) Sh(cmd string) error

+ func (io *IO) ShPipe(cmd string) (string, error)

+ func (io *IO) Spawn(cmd string, shell string, inherit bool) *ChildProcess

+ func (io *IO) Spinner(fn func(), message string)

+ func (io *IO) String(name string) string

+ func (io *IO) Success(messages ...string)

+ func (io *IO) View() *View

+ func (io *IO) Warn(messages ...string)

+ func (io *IO) WithGracefulExit(fn func(done <-chan bool)) bool

+ func (io *IO) Write(message string)

+ func (io *IO) Writef(format string, a ...any)

+ func (io *IO) Writeln(message string)

+ func (io *IO) Writelnf(format string, a ...any)

+ func (io *IO) Writelns(messages []string)

+ func (io *IO) Zsh(cmd string) error

+ func (io *IO) ZshPipe(cmd string) (string, error)

type Input

+ Strict bool

+ func (i *Input) GivenArguments() []string

type OptionalArrayFlag

+ func (f *OptionalArrayFlag) WasGiven() bool

type OptionalStringFlag

+ func (f *OptionalStringFlag) WasGiven() bool

type StringFlag

+ func (f *StringFlag) WasGiven() bool

v0.21.1

Sep 18, 2024

v0.21.0

Sep 15, 2024

Changes in this version

+ const Eol

+ const LogLevelAlert

+ const LogLevelCritical

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelFatal

+ const LogLevelInfo

+ const LogLevelNotice

+ const LogLevelWarn

+ func TerminalMakeRaw() error

+ func TerminalRestore() error

type Application

+ func (app *Application) RunExit(args ...string)

type ArrayArg

+ Options []string

type Command

+ PromptForInput bool

type ConfirmPrompt

+ Prefix string

type Ctx

+ func (c *Ctx) Sh(cmd string) (string, error)

+ func (c *Ctx) ShPipe(cmd string) (string, error)

+ func (c *Ctx) Zsh(cmd string) (string, error)

+ func (c *Ctx) ZshPipe(cmd string) (string, error)

+ type ErrMissingArguments interface

+ MissingArguments func() []string

type Input

+ func (i *Input) RestoreTty() error

+ func (i *Input) SetTty(mode string) (string, error)

+ type Logger interface

+ Alert func(message string)

+ Alertc func(message string, ctx any)

+ Alertf func(format string, args ...any)

+ Critical func(message string)

+ Criticalc func(message string, ctx any)

+ Criticalf func(format string, args ...any)

+ Debug func(message string)

+ Debugc func(message string, ctx any)

+ Debugf func(format string, args ...any)

+ EnableDebug func()

+ Error func(message string)

+ Errorc func(message string, ctx any)

+ Errorf func(format string, args ...any)

+ Fatal func(message string)

+ Fatalc func(message string, ctx any)

+ Fatalf func(format string, args ...any)

+ Info func(message string)

+ Infoc func(message string, ctx any)

+ Infof func(format string, args ...any)

+ Notice func(message string)

+ Noticec func(message string, ctx any)

+ Noticef func(format string, args ...any)

+ SetLogLevel func(level int)

+ Warn func(message string)

+ Warnc func(message string, ctx any)

+ Warnf func(format string, args ...any)

+ func NewLogger(o *Output, level int) Logger

type Output

+ func (o *Output) CreateBlock(messages []string, tag string, theme *Theme, escape bool) []string

+ func (o *Output) Format(message string) string

+ func (o *Output) Formatf(format string, args ...any) string

type Prompt

+ AllowNewLine bool

+ GetValue func() string

+ Ignore func(key string) bool

+ Submit bool

+ func (p *Prompt) AddCursor(value string, cursorPosition int, maxWidth int) string

+ func (p *Prompt) CursorPosition() int

+ func (p *Prompt) Highlight(index int)

+ func (p *Prompt) HighlightNext(total int)

+ func (p *Prompt) HighlightPrevious(total int)

+ func (p *Prompt) InitializeScrolling(highlighted int)

+ func (p *Prompt) ReduceScrollingToFitTerminal()

+ func (p *Prompt) Reset()

+ func (p *Prompt) Resetvalue()

+ func (p *Prompt) ScrollToHighlighted(total int)

+ func (p *Prompt) SetValue(value string)

+ func (p *Prompt) Submitted() bool

+ func (p *Prompt) Track(key string)

+ func (p *Prompt) TypedValue() string

+ type PromptFunc func(i *Input, o *Output, arg Arg) error

type StringArg

+ Options []string

type TextPrompt

+ func (tp *TextPrompt) View() string

+ type View struct

+ func NewView(o *Output) *View

+ func (v *View) Clear()

+ func (v *View) HideCursor()

+ func (v *View) Render(frame string)

+ func (v *View) RenderLine(frame string)

+ func (v *View) RenderLinef(format string, args ...any)

+ func (v *View) ShowCursor()

+ func (v *View) Write(frame string)

v0.20.0

Sep 7, 2024

Changes in this version

type ChildProcess

+ func (cp *ChildProcess) Kill() error

type Ctx

+ func (c *Ctx) View() *View

+ func (c *Ctx) WithGracefulExit(fn func(done <-chan bool)) bool

+ type SpinnerFrame struct

+ Frames []string

+ func (s *SpinnerFrame) Next() string

v0.19.2

Sep 6, 2024

v0.19.1

Sep 6, 2024

Changes in this version

+ const ArrowDown

+ const ArrowLeft

+ const ArrowLeftRight

+ const ArrowRight

+ const ArrowUp

+ const ArrowUpDown

+ const BoxBottomLeft

+ const BoxBottomRight

+ const BoxCross

+ const BoxHorizontal

+ const BoxHorizontalDown

+ const BoxHorizontalUp

+ const BoxTopLeft

+ const BoxTopRight

+ const BoxVertical

+ const BoxVerticalLeft

+ const BoxVerticalRight

+ const CbarBell

+ const CharEllipsis

+ const CharNewline

+ const CharSpace

+ const CharTab

+ const ChevronDefault

+ const ChevronHeavy

+ const ChevronSmall

+ const CircleDotted

+ const CircleDoubled

+ const CircleFilled

+ const CircleHalfBottom

+ const CircleHalfLeft

+ const CircleHalfRight

+ const CircleHalfTop

+ const CircleOutline

+ const CircleOutlineFilled

+ const CircleSmall

+ const DiamondDefault

+ const DiamondOutline

+ const DoubleBoxBottomLeft

+ const DoubleBoxBottomRight

+ const DoubleBoxCross

+ const DoubleBoxHorizontal

+ const DoubleBoxHorizontalDown

+ const DoubleBoxHorizontalUp

+ const DoubleBoxTopLeft

+ const DoubleBoxTopRight

+ const DoubleBoxVertical

+ const DoubleBoxVerticalLeft

+ const DoubleBoxVerticalRight

+ const HeartDefault

+ const HeartOutline

+ const HeavyBoxBottomLeft

+ const HeavyBoxBottomRight

+ const HeavyBoxCross

+ const HeavyBoxHorizontal

+ const HeavyBoxHorizontalDown

+ const HeavyBoxHorizontalUp

+ const HeavyBoxTopLeft

+ const HeavyBoxTopRight

+ const HeavyBoxVertical

+ const HeavyBoxVerticalLeft

+ const HeavyBoxVerticalRight

+ const IconCross

+ const IconCrossSwoosh

+ const IconHome

+ const IconInfo

+ const IconNote

+ const IconStar

+ const IconTick

+ const IconTickSwoosh

+ const IconWarning

+ const LineDiagonal

+ const LineDiagonalCross

+ const LineDiagonalbackwards

+ const LineHorizontal

+ const LineHorizontalDashed

+ const LineHorizontalDashedHeavy

+ const LineHorizontalHeavy

+ const LineVertical

+ const LineVerticalDashed

+ const LineVerticalDashedHeavy

+ const LineVerticalHeavy

+ const RoundedBoxBottomLeft

+ const RoundedBoxBottomRight

+ const RoundedBoxCross

+ const RoundedBoxHorizontal

+ const RoundedBoxHorizontalDown

+ const RoundedBoxHorizontalUp

+ const RoundedBoxTopLeft

+ const RoundedBoxTopRight

+ const RoundedBoxVertical

+ const RoundedBoxVerticalLeft

+ const RoundedBoxVerticalRight

+ const ShadeHeavy

+ const ShadeLight

+ const ShadeMedium

+ const SmallTriangleDown

+ const SmallTriangleLeft

+ const SmallTriangleRight

+ const SmallTriangleUp

+ const SquareCrossed

+ const SquareDefault

+ const SquareOutline

+ const ThemeBlock

+ const ThemeIcon

+ const TriangleDown

+ const TriangleLeft

+ const TriangleRight

+ const TriangleUp

+ var CircleSpinner []string = []string

+ var DotSpinner []string = []string

+ func AddThemeSet(name string, themeSet map[string]*Theme)

+ func GetStyleTags() []string

+ func Longest(lines []string, minWidth int, padding int) int

+ func MbSplit(s string, length int) []string

+ func MbSubstr(s string, start int, length int) string

+ func Pad(text string, length int, char string) string

+ func PadCenter(text string, length int, char string) string

+ func PadEnd(text string, length int, char string) string

+ func PadStart(text string, length int, char string) string

+ func SetCurrentThemeSet(name string)

+ func StrimWidth(str string, start int, width int, trimMarker string) string

+ func StripEscapeSequences(text string) string

+ func TrimWidthBackwards(str string, start int, width int) string

+ func TruncateStart(text string, width int) string

type Theme

+ FullyColored bool

+ Icon string

+ Label string

+ Padding bool

+ func GetTheme(tag string) (*Theme, error)

+ func (t *Theme) GetStyle() *OutputFormatterStyle

v0.19.0

Sep 6, 2024

Changes in this version

type ArrayFlag

+ func (f *ArrayFlag) HasValue() bool

type BoolFlag

+ func (f *BoolFlag) HasValue() bool

type Ctx

+ func (c *Ctx) Note(messages ...string)

+ func (c *Ctx) Success(messages ...string)

type Flag

+ HasValue func() bool

type OptionalArrayFlag

+ func (f *OptionalArrayFlag) HasValue() bool

type OptionalStringFlag

+ func (f *OptionalStringFlag) HasValue() bool

type Output

+ func (o *Output) Error(messages ...string)

+ func (o *Output) Ok(messages ...string)

type StringFlag

+ func (f *StringFlag) HasValue() bool

v0.18.1

Sep 5, 2024

v0.18.0

Sep 5, 2024

Changes in this version

+ const FormArray

+ const FormConfirm

+ const FormMultiselect

+ const FormPause

+ const FormSelect

+ const FormText

+ const FormTextArea

+ const FormWait

+ const PromptStateDeleting

+ var ErrCancelledSpinner = errors.New("cancelled")

+ func ArgSetValue(arg Arg, token string)

+ func CreateForm(i *Input, o *Output, first *FormStep, steps ...*FormStep) form

+ func FlagAcceptsValue(f Flag) bool

+ func FlagEquals(f1 Flag, f2 Flag) bool

+ func FlagHasDefaultValue(f Flag) bool

+ func FlagIsArray(f Flag) bool

+ func FlagIsNegatable(f Flag) bool

+ func FlagRequiresValue(f Flag) bool

+ func FlagType(f Flag) uint

+ func FlagValueIsOptional(f Flag) bool

+ func GetArgArrayValue(arg Arg) []string

+ func GetArgStringValue(arg Arg) string

+ func GetFlagArrayValue(f any) []string

+ func GetFlagBoolValue(f any) bool

+ func GetFlagStringValue(f any) string

+ func SetFlagValue(f Flag, str string, boolean bool)

+ func ValidateArg(arg Arg) error

+ func ValidateFlag(f Flag) error

type Application

+ Commands []*Command

+ Debug bool

+ func (app *Application) ExitCode() int

+ type Arg interface

+ GetDescription func() string

+ GetName func() string

+ HasValue func() bool

+ IsRequired func() bool

+ type ArrayArg struct

+ Description string

+ Min uint

+ Name string

+ Validator func([]string) error

+ Value []string

+ func (a *ArrayArg) GetDescription() string

+ func (a *ArrayArg) GetName() string

+ func (a *ArrayArg) HasValue() bool

+ func (a *ArrayArg) IsRequired() bool

+ type ArrayFlag struct

+ Description string

+ Name string

+ Shortcuts []string

+ Validator func([]string) error

+ Value []string

+ func (f *ArrayFlag) GetDescription() string

+ func (f *ArrayFlag) GetName() string

+ func (f *ArrayFlag) GetShortcutString() string

+ func (f *ArrayFlag) GetShortcuts() []string

+ type ArrayPrompt struct

+ DefaultValue string

+ Hint string

+ Label string

+ Placeholder string

+ Values []string

+ func NewArrayPrompt(i *Input, o *Output, label string, defaultValue []string) *ArrayPrompt

+ func (p *ArrayPrompt) Render() ([]string, error)

+ func (p *ArrayPrompt) String() string

+ type BoolFlag struct

+ Description string

+ Name string

+ Negatable bool

+ Shortcuts []string

+ Validator func(bool) error

+ Value bool

+ func (f *BoolFlag) GetDescription() string

+ func (f *BoolFlag) GetName() string

+ func (f *BoolFlag) GetShortcutString() string

+ func (f *BoolFlag) GetShortcuts() []string

type Command

+ Debug bool

+ Flags []Flag

+ RunE CommandHandleE

+ Signature string

+ func (c *Command) AddFlag(flag Flag) *Command

+ func (c *Command) Execute(args ...string) (int, error)

+ func (c *Command) ExecuteWith(i *Input, o *Output) (int, error)

+ type CommandHandleE func(ctx *Ctx) error

+ type ConfirmPrompt struct

+ Confirmed bool

+ DefaultValue bool

+ Hint string

+ Label string

+ No string

+ Yes string

+ func NewConfirmPrompt(i *Input, o *Output, label string) *ConfirmPrompt

+ func (cp *ConfirmPrompt) Render() (bool, error)

+ func (cp *ConfirmPrompt) String() string

+ type Ctx struct

+ Args []string

+ Code int

+ Debug bool

+ Input *Input

+ Output *Output

+ func (c *Ctx) Alert(messages ...string)

+ func (c *Ctx) Array(name string) []string

+ func (c *Ctx) Ask(question string, defaultValue string) (string, error)

+ func (c *Ctx) Bool(name string) bool

+ func (c *Ctx) ChildProcess(cmd string) *ChildProcess

+ func (c *Ctx) Choice(question string, choices map[string]string, defaultValue string) (string, error)

+ func (c *Ctx) Comment(messages ...string)

+ func (c *Ctx) Confirm(question string, defaultValue bool) (bool, error)

+ func (c *Ctx) Err(err error)

+ func (c *Ctx) Error(messages ...string)

+ func (c *Ctx) Exec(cmd string, shell string, inherit bool) (string, error)

+ func (c *Ctx) Info(messages ...string)

+ func (c *Ctx) IsDebug() bool

+ func (c *Ctx) IsDecorated() bool

+ func (c *Ctx) IsQuiet() bool

+ func (c *Ctx) IsVerbose() bool

+ func (c *Ctx) IsVeryVerbose() bool

+ func (c *Ctx) NewLine(count uint)

+ func (c *Ctx) Ok(messages ...string)

+ func (c *Ctx) Spawn(cmd string, shell string, inherit bool) *ChildProcess

+ func (c *Ctx) Spinner(fn func(), message string)

+ func (c *Ctx) String(name string) string

+ func (c *Ctx) Warn(messages ...string)

+ func (c *Ctx) Write(message string)

+ func (c *Ctx) Writef(format string, a ...any)

+ func (c *Ctx) Writeln(message string)

+ func (c *Ctx) Writelnf(format string, a ...any)

+ func (c *Ctx) Writelns(messages []string)

+ type Flag interface

+ GetDescription func() string

+ GetName func() string

+ GetShortcutString func() string

+ GetShortcuts func() []string

+ type FormStep struct

+ Array *[]string

+ Bool *bool

+ Label string

+ Labels []string

+ Placeholder string

+ Required bool

+ String *string

+ Type uint

+ Values []string

+ WaitFunc func()

type Input

+ func (i *Input) Array(name string) ([]string, error)

+ func (i *Input) Bool(name string) (bool, error)

+ func (i *Input) HasFlag(name string) bool

+ func (i *Input) HasParameterFlag(value string, onlyParams bool) bool

+ func (i *Input) ParameterFlag(value string, defaultValue InputType, onlyParams bool) InputType

+ func (i *Input) SetFlag(name string, str string, boolean bool) error

type InputDefinition

+ func (d *InputDefinition) AddFlag(flag Flag)

+ func (d *InputDefinition) AddFlags(flags []Flag)

+ func (d *InputDefinition) Flag(name string) (Flag, error)

+ func (d *InputDefinition) FlagForShortcut(shortcut string) (Flag, error)

+ func (d *InputDefinition) GetFlags() []Flag

+ func (d *InputDefinition) HasFlag(name string) bool

+ func (d *InputDefinition) SetFlags(flags []Flag)

+ type OptionalArrayFlag struct

+ Boolean bool

+ Description string

+ Name string

+ Shortcuts []string

+ Validator func(bool, []string) error

+ Value []string

+ func (f *OptionalArrayFlag) GetDescription() string

+ func (f *OptionalArrayFlag) GetName() string

+ func (f *OptionalArrayFlag) GetShortcutString() string

+ func (f *OptionalArrayFlag) GetShortcuts() []string

+ type OptionalStringFlag struct

+ Boolean bool

+ Description string

+ Name string

+ Shortcuts []string

+ Validator func(bool, string) error

+ Value string

+ func (f *OptionalStringFlag) GetDescription() string

+ func (f *OptionalStringFlag) GetName() string

+ func (f *OptionalStringFlag) GetShortcutString() string

+ func (f *OptionalStringFlag) GetShortcuts() []string

+ type PausePrompt struct

+ Message string

+ func NewPausePrompt(i *Input, o *Output, message string) *PausePrompt

+ func (p *PausePrompt) Render() (bool, error)

+ func (p *PausePrompt) String() string

type Prompt

+ func (p *Prompt) ClearListeners()

+ type SelectPrompt struct

+ DefaultValue string

+ Hint string

+ Label string

+ Labels []string

+ Scroll int

+ Values []string

+ func NewSelectPrompt(i *Input, o *Output, label string, values []string, labels []string, ...) *SelectPrompt

+ func (p *SelectPrompt) GetLabel() string

+ func (p *SelectPrompt) Render() (string, error)

+ func (p *SelectPrompt) String() string

+ func (p *SelectPrompt) Visible() []string

+ type StringArg struct

+ Description string

+ Name string

+ Required bool

+ Validator func(string) error

+ Value string

+ func (a *StringArg) GetDescription() string

+ func (a *StringArg) GetName() string

+ func (a *StringArg) HasValue() bool

+ func (a *StringArg) IsRequired() bool

+ type StringFlag struct

+ Description string

+ Name string

+ Shortcuts []string

+ Validator func(string) error

+ Value string

+ func (f *StringFlag) GetDescription() string

+ func (f *StringFlag) GetName() string

+ func (f *StringFlag) GetShortcutString() string

+ func (f *StringFlag) GetShortcuts() []string

type TextDescriptor

+ func (d *TextDescriptor) DescribeArgument(argument Arg, options *DescriptorOptions)

+ func (d *TextDescriptor) DescribeFlag(flag Flag, options *DescriptorOptions)

+ type TextPrompt struct

+ DefaultValue string

+ Hint string

+ Label string

+ Placeholder string

+ func NewTextPrompt(i *Input, o *Output, label string, defaultValue string) *TextPrompt

+ func (tp *TextPrompt) Render() (string, error)

+ func (tp *TextPrompt) String() string

+ func (tp *TextPrompt) ValueWithCursor(maxWidth int) string

+ type WaitPrompt struct

+ WaitFunc func() bool

+ func NewWaitPrompt(i *Input, o *Output, waitFunc func() bool, message string) *WaitPrompt

+ func (p *WaitPrompt) Render() error

+ func (p *WaitPrompt) String() string

v0.17.5

Aug 26, 2024

v0.17.4

Aug 26, 2024

Changes in this version

type Command

+ func NewCommand(signature string, handle CommandHandle) (*Command, error)

+ type ParsedSignature struct

+ Aliases []string

+ Arguments []*InputArgument

+ Description string

+ Expression string

+ Name string

+ Options []*InputOption

+ func ParseSignature(expr string) (*ParsedSignature, error)

v0.17.3

Aug 20, 2024

v0.17.2

Aug 20, 2024

v0.17.1

Aug 20, 2024

v0.17.0

Aug 20, 2024

Changes in this version

type Command

+ func (c *Command) RunWith(i *Input, o *Output) (int, error)

type TableCell

+ Raw bool

v0.16.6

Aug 20, 2024

v0.16.5

Aug 19, 2024

v0.16.4

Aug 19, 2024

v0.16.3

Aug 19, 2024

v0.16.2

Aug 19, 2024

v0.16.1

Aug 19, 2024

v0.16.0

Aug 19, 2024

Changes in this version

+ const BorderInside

+ const BorderOutside

+ const DefaultTableCellAlign

+ const DisplayOrientationDefault

+ const DisplayOrientationHorizontal

+ const DisplayOrientationVertical

+ const PromptStateActive

+ const PromptStateCancel

+ const PromptStateError

+ const PromptStateInitial

+ const PromptStateSearching

+ const PromptStateSubmit

+ const SeparatorBottom

+ const SeparatorMid

+ const SeparatorTop

+ const SeparatorTopBottom

+ const TableCellAlignCenter

+ const TableCellAlignLeft

+ const TableCellAlignRight

+ func RegisterTableStyle(name string, style *TableStyle)

type Command

+ func (c *Command) Error(messages ...string)

+ type ConsoleSectionOutput struct

+ func NewConsoleSectionOutput(o *Output, sections []*ConsoleSectionOutput) *ConsoleSectionOutput

+ func (c *ConsoleSectionOutput) AddContent(input string, newLine bool) int

+ func (c *ConsoleSectionOutput) AddNewLineOfInputSubmit()

+ func (c *ConsoleSectionOutput) Clear(lines int)

+ func (c *ConsoleSectionOutput) Content() string

+ func (c *ConsoleSectionOutput) DoWrite(message string, newLine bool)

+ func (c *ConsoleSectionOutput) Overwrite(message string)

+ func (c *ConsoleSectionOutput) OverwriteMany(message []string)

+ func (c *ConsoleSectionOutput) SetMaxHeight(maxHeight int)

+ func (c *ConsoleSectionOutput) VisibleContent() string

type Output

+ func (o *Output) CreateTable(headers []string, rows [][]*TableCell, options *TableOptions) *Table

+ func (o *Output) CreateTableRowsFromMaps(headers []string, rows []map[string]any) [][]*TableCell

+ func (o *Output) CreateTableRowsFromSlices(rows [][]any) [][]*TableCell

+ func (o *Output) TableFromMap(rows []map[string]any, headers []string, options *TableOptions)

+ func (o *Output) TableFromSlices(headers []string, rows [][]any, options *TableOptions)

+ type Table struct

+ func NewTable(o *Output) *Table

+ func (t *Table) AddRow(rows []*TableCell)

+ func (t *Table) AddRows(rows [][]*TableCell)

+ func (t *Table) AppendRow(row []*TableCell)

+ func (t *Table) ColumnStyle(columnIndex int) *TableStyle

+ func (t *Table) Render()

+ func (t *Table) SetColumnMaxWidth(columnIndex int, maxWidth int)

+ func (t *Table) SetColumnStyle(i uint, style *TableStyle)

+ func (t *Table) SetColumnStyleByName(i uint, name string)

+ func (t *Table) SetColumnWidth(columnIndex int, width int)

+ func (t *Table) SetColumnWidths(widths []int)

+ func (t *Table) SetFooterTitle(title string)

+ func (t *Table) SetHeaderTitle(title string)

+ func (t *Table) SetHeaders(headers []string)

+ func (t *Table) SetHorizontal(horizontal bool)

+ func (t *Table) SetRow(columnIndex int, row []*TableCell)

+ func (t *Table) SetRows(rows [][]*TableCell)

+ func (t *Table) SetStyle(style *TableStyle)

+ func (t *Table) SetStyleByName(style string)

+ func (t *Table) SetVertical(vertical bool)

+ func (t *Table) Style() *TableStyle

+ type TableCell struct

+ ColSpan uint

+ IsSeparator bool

+ RowSpan uint

+ Style *TableCellStyle

+ Value string

+ func NewTableCell(value string) *TableCell

+ func NewTableSeparator() *TableCell

+ func (c *TableCell) String() string

+ type TableCellStyle struct

+ Align string

+ Background string

+ CellFormat string

+ Foreground string

+ Options []string

+ type TableOptions struct

+ Align string

+ DisplayOrientation string

+ FooterTitle string

+ HeaderTitle string

+ Style string

+ type TableStyle struct

+ BorderFormat string

+ CellHeaderFormat string

+ CellRowContentFormat string

+ CellRowFormat string

+ CrossingBottomLeftChar string

+ CrossingBottomMidChar string

+ CrossingBottomRightChar string

+ CrossingChar string

+ CrossingMidLeftChar string

+ CrossingMidRightChar string

+ CrossingTopLeftBottomChar string

+ CrossingTopLeftChar string

+ CrossingTopMidBottomChar string

+ CrossingTopMidChar string

+ CrossingTopRightBottomChar string

+ CrossingTopRightChar string

+ FooterTitleFormat string

+ HeaderTitleFormat string

+ HorizontalInsideBorderChar string

+ HorizontalOutsideBorderChar string

+ PadType string

+ PaddingChar string

+ VerticalInsideBorderChar string

+ VerticalOutsideBorderChar string

+ func NewTableStyle(name string) *TableStyle

+ func (s *TableStyle) Clone() *TableStyle

+ func (ts *TableStyle) SetDefaultCrossingChar(char string)

v0.15.1

Aug 7, 2024

v0.15.0

Aug 7, 2024

Changes in this version

+ func SetBaseTheme(primary string, accent string)

v0.14.1

Aug 7, 2024

Changes in this version

type ChildProcess

+ func (cp *ChildProcess) String() string

v0.14.0

Aug 7, 2024

Changes in this version

type ChildProcess

+ Env []string

+ func (cp *ChildProcess) AddEnv(name string, value string)

type Command

+ func (c *Command) IsDebug() bool

+ func (c *Command) IsDecorated() bool

+ func (c *Command) IsQuiet() bool

+ func (c *Command) IsVerbose() bool

+ func (c *Command) IsVeryVerbose() bool

+ func (c *Command) Spawn(cmd string, shell string, inherit bool) *ChildProcess

v0.13.1

Aug 7, 2024

Changes in this version

type Command

+ func (c *Command) Write(message string, options uint)

v0.13.0

Aug 7, 2024

Changes in this version

+ var CustomOutputTheme = map[string]*OutputFormatterStyle

+ func AddTheme(tag string, theme Theme)

type Spinner

+ Color string

+ Frames []string

+ type Theme struct

+ Background string

+ Foreground string

+ Options []string

v0.12.0

Aug 6, 2024

Changes in this version

+ const PROMPT_STATE_ACTIVE

+ const PROMPT_STATE_CANCEL

+ const PROMPT_STATE_ERROR

+ const PROMPT_STATE_INITIAL

+ const PROMPT_STATE_SEARCHING

+ const PROMPT_STATE_SUBMIT

+ func RenderSpinner(s *Spinner) string

+ type AnyFunc func() any

type Command

+ func (c *Command) Alert(messages ...string)

+ func (c *Command) Comment(messages ...string)

+ func (c *Command) Err(messages ...string)

+ func (c *Command) Info(messages ...string)

+ func (c *Command) NewLine(count uint)

+ func (c *Command) Ok(messages ...string)

+ func (c *Command) Spinner(fn func(), message string)

+ func (c *Command) Warn(messages ...string)

+ func (c *Command) Writeln(message string, options uint)

+ func (c *Command) Writelns(messages []string, options uint)

+ type Listener func(key string)

type Output

+ func (o *Output) Writelnf(f string, options uint, args ...any)

+ type Prompt struct

+ CancelMessage string

+ CancelUsingFn AnyFunc

+ DefaultValue string

+ Error string

+ FirstVisible int

+ Highlighted int

+ Input *Input

+ Name string

+ Output *Output

+ Required bool

+ RevertUsingFn AnyFunc

+ Scroll int

+ State uint

+ ValidateUsingFn func(any) string

+ Validator func(string) string

+ func NewPrompt(name string, i *Input, o *Output) *Prompt

+ func (p *Prompt) Fallback() string

+ func (p *Prompt) Prompt(renderer func() string) (string, error)

+ func (p *Prompt) Render(frame string)

+ func (p *Prompt) Restore()

+ func (p *Prompt) ShouldFallback() bool

+ func (p *Prompt) Value() string

+ type Renderer struct

+ func NewRenderer() *Renderer

+ func (r *Renderer) Err(message string)

+ func (r *Renderer) Hint(message string)

+ func (r *Renderer) Line(message string, newLine bool)

+ func (r *Renderer) NewLine(count int)

+ func (r *Renderer) ToString(state uint) string

+ func (r *Renderer) Warning(message string)

+ func (r *Renderer) When(condition bool, cb func(*Renderer), defaultCb func(*Renderer))

+ type RendererInterface interface

+ Render func(prompt any)

+ String func() string

+ func NewSpinnerRenderer() RendererInterface

+ type Spinner struct

+ Count int

+ Interval int

+ Message string

+ func NewSpinner(i *Input, o *Output, message string) *Spinner

+ func (s *Spinner) Spin(fn func())

v0.11.0

Aug 5, 2024

Changes in this version

type Output

+ func (o *Output) Block(messages []string, tag string, style string, prefix string, padding bool, ...)

+ func (o *Output) Comment(messages []string)

v0.10.3

Aug 5, 2024

v0.10.2

Aug 5, 2024

Changes in this version

type Input

+ Args []string

type Output

+ Stderr *Output

v0.10.1

Aug 4, 2024

v0.10.0

Aug 4, 2024

Changes in this version

+ const ChoiceQuestionDefaultErrorMessage

+ const ChoiceQuestionDefaultPrompt

+ const InputArgumentIsArray

+ const InputArgumentOptional

+ const InputArgumentRequired

+ const InputOptionBool

+ const InputOptionIsArray

+ const InputOptionNegatable

+ const InputOptionOptional

+ const InputOptionRequired

+ const OutputNormal

+ const OutputPlain

+ const OutputRaw

+ const VerbosityDebug

+ const VerbosityNormal

+ const VerbosityQuiet

+ const VerbosityVerbose

+ const VerbosityVeryVerbose

+ var DefaultOutputTheme = map[string]*OutputFormatterStyle

+ var TrueAnswerRegex = regexp.MustCompile("(?i)^y")

+ func Ask[T any](i *Input, o *Output, question QuestionInterface) (T, error)

+ func BgBlack(text string) string

+ func BgBlue(text string) string

+ func BgCyan(text string) string

+ func BgGreen(text string) string

+ func BgMagenta(text string) string

+ func BgRed(text string) string

+ func BgWhite(text string) string

+ func BgYellow(text string) string

+ func Black(text string) string

+ func Blue(text string) string

+ func Bold(text string) string

+ func ColorMode() uint8

+ func ConvertFromHexToAnsiColorCode(mode uint8, hexColor string) (string, error)

+ func Cyan(text string) string

+ func Dim(text string) string

+ func Escape(s string) string

+ func EscapeTrailingBackslash(s string) string

+ func FormatBlock(messages []string, style string, large bool) string

+ func FormatSection(section string, message string, style string) string

+ func Gray(text string) string

+ func Green(text string) string

+ func HasColorSupport() bool

+ func HasInt(c Collection[int], v int) bool

+ func HasString(c Collection[string], v string) bool

+ func Hidden(text string) string

+ func InputTypeToArray(value InputType) []string

+ func InputTypeToString(value InputType) string

+ func Inverse(text string) string

+ func Italic(text string) string

+ func Magenta(text string) string

+ func Red(text string) string

+ func Reduce[T any, U any](c Collection[T], fn func(acc U, cur T, i int) U, initial U) U

+ func Reset(text string) string

+ func Strikethrough(text string) string

+ func StringToInputArgs(cmd string) []string

+ func TerminalHeight() (int, error)

+ func TerminalIsInteractive() bool

+ func TerminalSize() (int, int, error)

+ func TerminalWidth() (int, error)

+ func Truncate(message string, length int, suffix string) string

+ func Underline(text string) string

+ func White(text string) string

+ func Yellow(text string) string

+ type Application struct

+ AutoExit bool

+ CatchErrors bool

+ DefaultCommand string

+ LongVersion string

+ Name string

+ SingleCommand bool

+ Version string

+ func (app *Application) Abbreviations(names []string) map[string][]string

+ func (app *Application) Add(commands ...*Command)

+ func (app *Application) AddCommands(commands []*Command)

+ func (app *Application) All(namespace string) map[string]*Command

+ func (app *Application) Definition() *InputDefinition

+ func (app *Application) ExtractNamespace(name string, limit int) string

+ func (app *Application) Find(name string) (*Command, error)

+ func (app *Application) FindNamespace(namespace string) (string, error)

+ func (app *Application) Get(name string) (*Command, error)

+ func (app *Application) Has(name string) bool

+ func (app *Application) Help() string

+ func (app *Application) Namespaces() []string

+ func (app *Application) RenderError(o *Output, err error)

+ func (app *Application) Run(args ...string) (exitCode int, err error)

+ func (app *Application) RunWith(i *Input, o *Output) (exitCode int, err error)

+ func (app *Application) SetDefaultCommand(commandName string, isSingleCommand bool) error

+ func (app *Application) SetDefinition(definition *InputDefinition)

+ type ApplicationDescription struct

+ Application *Application

+ Namespace string

+ ShowHidden bool

+ func (d *ApplicationDescription) Command(name string) (*Command, error)

+ func (d *ApplicationDescription) Commands() map[string]*Command

+ func (d *ApplicationDescription) Namespaces() map[string]*NamespaceCommands

+ type AvailableOption struct

+ type Box struct

+ func (b *Box) Draw(title string, body string, footer string, color string, info string) string

+ type ChildProcess struct

+ Args []string

+ Cmd string

+ Inherit bool

+ Pipe bool

+ Shell string

+ Stderr *os.File

+ Stdin *os.File

+ Stdout *os.File

+ func (cp *ChildProcess) Run() (string, error)

+ func (cp *ChildProcess) Start() error

+ func (cp *ChildProcess) Wait() error

+ type ChoiceQuestion struct

+ Choices map[string]string

+ Prompt string

+ func (cq *ChoiceQuestion) DefaultValidator() QuestionValidator[string]

+ func (cq *ChoiceQuestion) SetErrorMessage(message string)

+ type Collection []T

+ func Collect[T any](data []T) Collection[T]

+ func Map[T any, U any](collection Collection[T], fn func(T) U) Collection[U]

+ func (c *Collection[T]) PopBack() T

+ func (c *Collection[T]) PopFront() T

+ func (c *Collection[T]) PushBack(v ...T)

+ func (c *Collection[T]) PushFront(v ...T)

+ func (c Collection[T]) Every(fn func(T) bool) bool

+ func (c Collection[T]) Filter(predicate func(T) bool) Collection[T]

+ func (c Collection[T]) FilterInPlace(predicate func(T) bool) Collection[T]

+ func (c Collection[T]) FilterMapInPlace(predicate func(T) bool, mapper func(T) T) Collection[T]

+ func (c Collection[T]) Find(fn func(T) bool) (T, bool)

+ func (c Collection[T]) Has(value T, cmp func(T, T) bool) bool

+ func (c Collection[T]) IndexOf(value T, cmp func(T, T) bool) int

+ func (c Collection[T]) Len() int

+ func (c Collection[T]) Map(fn func(T) T) Collection[T]

+ func (c Collection[T]) MapInPlace(fn func(T) T) Collection[T]

+ func (c Collection[T]) Reverse() Collection[T]

+ func (c Collection[T]) ReverseInPlace() Collection[T]

+ func (c Collection[T]) Some(fn func(T) bool) bool

+ func (c Collection[T]) Splice(start int, end int) Collection[T]

+ type Color struct

+ Background string

+ Foreground string

+ Options []string

+ func (c *Color) Apply(text string) string

+ func (c *Color) Set() string

+ func (c *Color) Unset() string

+ type Command struct

+ Aliases []string

+ Description string

+ Handle CommandHandle

+ Help string

+ Hidden bool

+ IgnoreValidationErrors bool

+ Initializer CommandInitializer

+ Interacter CommandInteracter

+ Name string

+ func (c *Command) AddArgument(arg *InputArgument) *Command

+ func (c *Command) AddOption(option *InputOption) *Command

+ func (c *Command) AddUsage(usage string) *Command

+ func (c *Command) ApplicationDefinition() *InputDefinition

+ func (c *Command) Arguments() map[string]InputType

+ func (c *Command) ArrayArgument(name string) ([]string, error)

+ func (c *Command) ArrayOption(name string) ([]string, error)

+ func (c *Command) BoolOption(name string) (bool, error)

+ func (c *Command) DefineArgument(name string, mode InputArgumentMode, description string, ...) *Command

+ func (c *Command) DefineOption(name string, shortcut string, mode InputOptionMode, description string, ...) *Command

+ func (c *Command) Definition() *InputDefinition

+ func (c *Command) Describe(output *Output, options uint)

+ func (c *Command) Exec(cmd string, shell string, inherit bool) (string, error)

+ func (c *Command) Fail(e string) (int, error)

+ func (c *Command) Input() *Input

+ func (c *Command) IsEnabled() bool

+ func (c *Command) MergeApplication(mergeArgs bool)

+ func (c *Command) Meta() any

+ func (c *Command) NativeDefinition() *InputDefinition

+ func (c *Command) Options() map[string]InputType

+ func (c *Command) Output() *Output

+ func (c *Command) ProcessedHelp() string

+ func (c *Command) Run(i *Input, o *Output) (int, error)

+ func (c *Command) SetAliases(aliases []string) *Command

+ func (c *Command) SetApplicationDefinition(definition *InputDefinition)

+ func (c *Command) SetDefinition(definition *InputDefinition)

+ func (c *Command) SetDescription(description string) *Command

+ func (c *Command) SetHelp(help string) *Command

+ func (c *Command) SetHidden(hidden bool) *Command

+ func (c *Command) SetMeta(meta any)

+ func (c *Command) SetName(name string) *Command

+ func (c *Command) StringArgument(name string) (string, error)

+ func (c *Command) StringOption(name string) (string, error)

+ func (c *Command) Synopsis(short bool) string

+ func (c *Command) Usages() []string

+ type CommandHandle func(self *Command) (int, error)

+ type CommandInitializer func(input *Input, output *Output)

+ type CommandInteracter func(input *Input, output *Output)

+ type CommandNotFoundError struct

+ func (e *CommandNotFoundError) Alternatives() []string

+ func (e *CommandNotFoundError) Error() string

+ type ConfirmationQuestion struct

+ func (q *ConfirmationQuestion) DefaultNormalizer() QuestionNormalizer[bool]

+ type Cursor struct

+ Input *os.File

+ Output *Output

+ func (c *Cursor) ClearLine() *Cursor

+ func (c *Cursor) ClearLineAfter() *Cursor

+ func (c *Cursor) ClearOutput() *Cursor

+ func (c *Cursor) ClearScreen() *Cursor

+ func (c *Cursor) CurrentPosition() (int, int)

+ func (c *Cursor) Hide() *Cursor

+ func (c *Cursor) Move(x int, y int) *Cursor

+ func (c *Cursor) MoveDown(lines int) *Cursor

+ func (c *Cursor) MoveLeft(columns int) *Cursor

+ func (c *Cursor) MoveRight(columns int) *Cursor

+ func (c *Cursor) MoveToColumn(column int) *Cursor

+ func (c *Cursor) MoveToPosition(column int, row int) *Cursor

+ func (c *Cursor) MoveUp(lines int) *Cursor

+ func (c *Cursor) RestorePosition() *Cursor

+ func (c *Cursor) SavePosition() *Cursor

+ func (c *Cursor) Show() *Cursor

+ type DescriptorOptions struct

+ type ErrorWithAlternatives interface

+ Alternatives func() []string

+ func CommandNotFound(message string, alternatives []string) ErrorWithAlternatives

+ func NamespaceNotFound(message string, alternatives []string) ErrorWithAlternatives

+ type Input struct

+ Tokens []string

+ func NewInput(args ...string) *Input

+ func (i *Input) Arguments() map[string]InputType

+ func (i *Input) ArrayArgument(name string) ([]string, error)

+ func (i *Input) ArrayOption(name string) ([]string, error)

+ func (i *Input) Bind(definition *InputDefinition)

+ func (i *Input) BoolOption(name string) (bool, error)

+ func (i *Input) EscapeToken(token string) string

+ func (i *Input) FirstArgument() InputType

+ func (i *Input) HasArgument(name string) bool

+ func (i *Input) HasOption(name string) bool

+ func (i *Input) HasParameterOption(value string, onlyParams bool) bool

+ func (i *Input) IsInteractive() bool

+ func (i *Input) Options() map[string]InputType

+ func (i *Input) ParameterOption(value string, defaultValue InputType, onlyParams bool) InputType

+ func (i *Input) Parse() error

+ func (i *Input) SetArgument(name string, value InputType) error

+ func (i *Input) SetDefinition(definition *InputDefinition) error

+ func (i *Input) SetInteractive(interactive bool)

+ func (i *Input) SetOption(name string, value InputType) error

+ func (i *Input) SetStream(stream *os.File)

+ func (i *Input) Stream() *os.File

+ func (i *Input) String() string

+ func (i *Input) StringArgument(name string) (string, error)

+ func (i *Input) StringOption(name string) (string, error)

+ func (i *Input) Validate() error

+ type InputArgument struct

+ DefaultValue InputType

+ Description string

+ Mode InputArgumentMode

+ Name string

+ Validator InputValidator

+ func (a *InputArgument) Clone() *InputArgument

+ func (a *InputArgument) IsArray() bool

+ func (a *InputArgument) IsRequired() bool

+ func (a *InputArgument) SetDefaultValue(value InputType) *InputArgument

+ func (a *InputArgument) SetValidator(validator InputValidator) *InputArgument

+ type InputArgumentMode uint8

+ type InputDefinition struct

+ Arguments []*InputArgument

+ Options []*InputOption

+ func (d *InputDefinition) AddArgument(argument *InputArgument)

+ func (d *InputDefinition) AddArguments(arguments []*InputArgument)

+ func (d *InputDefinition) AddOption(option *InputOption)

+ func (d *InputDefinition) AddOptions(options []*InputOption)

+ func (d *InputDefinition) Argument(name string) (*InputArgument, error)

+ func (d *InputDefinition) ArgumentByIndex(index uint) (*InputArgument, error)

+ func (d *InputDefinition) ArgumentCount() uint

+ func (d *InputDefinition) ArgumentDefaults() map[string]InputType

+ func (d *InputDefinition) ArgumentRequiredCount() uint

+ func (d *InputDefinition) GetArguments() []*InputArgument

+ func (d *InputDefinition) GetOptions() []*InputOption

+ func (d *InputDefinition) HasArgument(name string) bool

+ func (d *InputDefinition) HasNegation(name string) bool

+ func (d *InputDefinition) HasOption(name string) bool

+ func (d *InputDefinition) HasShortcut(name string) bool

+ func (d *InputDefinition) NegationToName(negation string) string

+ func (d *InputDefinition) Option(name string) (*InputOption, error)

+ func (d *InputDefinition) OptionDefaults() map[string]InputType

+ func (d *InputDefinition) OptionForShortcut(shortcut string) (*InputOption, error)

+ func (d *InputDefinition) SetArguments(arguments []*InputArgument)

+ func (d *InputDefinition) SetDefinition(arguments []*InputArgument, options []*InputOption)

+ func (d *InputDefinition) SetOptions(options []*InputOption)

+ func (d *InputDefinition) ShortcutToName(shortcut string) string

+ func (d *InputDefinition) Synopsis(short bool) string

+ type InputOption struct

+ DefaultValue InputType

+ Description string

+ Mode InputOptionMode

+ Name string

+ Shortcut string

+ Validator InputValidator

+ func (o *InputOption) AcceptValue() bool

+ func (o *InputOption) Clone() *InputOption

+ func (o *InputOption) Equals(opt *InputOption) bool

+ func (o *InputOption) IsArray() bool

+ func (o *InputOption) IsNegatable() bool

+ func (o *InputOption) IsValueOptional() bool

+ func (o *InputOption) IsValueRequired() bool

+ func (o *InputOption) SetDefaultValue(value InputType) *InputOption

+ func (o *InputOption) SetValidator(validator InputValidator) *InputOption

+ type InputOptionMode uint8

+ type InputParser func(self any) error

+ type InputType any

+ type InputValidator func(value InputType) error

+ type NamespaceCommands struct

+ type NamespaceNotFoundError struct

+ func (e *NamespaceNotFoundError) Alternatives() []string

+ func (e *NamespaceNotFoundError) Error() string

+ type Output struct

+ Stream *os.File

+ func NewOutput(input *Input) *Output

+ func (o *Output) Ask(questions string, defaultValue string, validator func(string) bool) string

+ func (o *Output) AskHidden(question string, validator func(string) bool) string

+ func (o *Output) Box(title string, body string, footer string, color string, info string)

+ func (o *Output) Caution(messages []string)

+ func (o *Output) Choice(question string, choices map[string]string, defaultValue string) string

+ func (o *Output) Confirm(q string, defaultValue bool) (bool, error)

+ func (o *Output) DoWrite(message string, newLine bool)

+ func (o *Output) Err(messages []string)

+ func (o *Output) ErrorOutput() *Output

+ func (o *Output) Formatter() *OutputFormatter

+ func (o *Output) Info(messages []string)

+ func (o *Output) IsDebug() bool

+ func (o *Output) IsDecorated() bool

+ func (o *Output) IsQuiet() bool

+ func (o *Output) IsVerbose() bool

+ func (o *Output) IsVeryVerbose() bool

+ func (o *Output) Listing(elements []string, prefix string)

+ func (o *Output) NewLine(count int)

+ func (o *Output) Note(messages []string)

+ func (o *Output) ProgressAdvance(step uint)

+ func (o *Output) ProgressFinish()

+ func (o *Output) ProgressStart(max uint)

+ func (o *Output) Section(message string)

+ func (o *Output) SetDecorated(decorated bool)

+ func (o *Output) SetErrorOutput(output *Output)

+ func (o *Output) SetFormatter(formatter *OutputFormatter)

+ func (o *Output) SetVerbosity(verbose uint)

+ func (o *Output) Success(messages []string)

+ func (o *Output) Table(headers []string, rows map[string]string)

+ func (o *Output) Text(messages []string)

+ func (o *Output) Title(message string)

+ func (o *Output) Verbosity() uint

+ func (o *Output) Warning(messages []string)

+ func (o *Output) Write(message string, newLine bool, options uint)

+ func (o *Output) WriteMany(messages []string, newLine bool, options uint)

+ func (o *Output) Writeln(s string, options uint)

+ func (o *Output) Writelns(s []string, options uint)

+ type OutputFormatter struct

+ Decorated bool

+ StyleStack *OutputFormatterStyleStack

+ Styles map[string]*OutputFormatterStyle

+ func (o *OutputFormatter) Clone() *OutputFormatter

+ func (o *OutputFormatter) Format(message string) string

+ func (o *OutputFormatter) FormatAndWrap(message string, width int) string

+ func (o *OutputFormatter) HasStyle(name string) bool

+ func (o *OutputFormatter) RemoveDecoration(str string) string

+ func (o *OutputFormatter) SetStyle(name string, style *OutputFormatterStyle)

+ func (o *OutputFormatter) Style(name string) (*OutputFormatterStyle, error)

+ type OutputFormatterStyle struct

+ func NewOutputFormatterStyle(foreground string, background string, options []string) *OutputFormatterStyle

+ func (s *OutputFormatterStyle) Apply(text string) string

+ func (s *OutputFormatterStyle) Clone() *OutputFormatterStyle

+ func (s *OutputFormatterStyle) SetBackground(c string)

+ func (s *OutputFormatterStyle) SetForeground(c string)

+ func (s *OutputFormatterStyle) SetHref(href string)

+ func (s *OutputFormatterStyle) SetOption(option string)

+ func (s *OutputFormatterStyle) SetOptions(options []string)

+ func (s *OutputFormatterStyle) UnsetOption(option string)

+ type OutputFormatterStyleStack struct

+ EmptyStyle *OutputFormatterStyle

+ Styles []*OutputFormatterStyle

+ func (s *OutputFormatterStyleStack) Clone() *OutputFormatterStyleStack

+ func (s *OutputFormatterStyleStack) Current() *OutputFormatterStyle

+ func (s *OutputFormatterStyleStack) Pop(style *OutputFormatterStyle) *OutputFormatterStyle

+ func (s *OutputFormatterStyleStack) Push(style *OutputFormatterStyle)

+ func (s *OutputFormatterStyleStack) Reset()

+ type OutputTheme map[string]*OutputFormatterStyle

+ type Question struct

+ Attempts int

+ DefaultValue T

+ Hidden bool

+ HiddenFallback bool

+ Multiline bool

+ Normalizer QuestionNormalizer[T]

+ PreventTrimming bool

+ Query string

+ Validator QuestionValidator[T]

+ func (q *Question[any]) DefaultNormalizer() QuestionNormalizer[any]

+ func (q *Question[any]) DefaultValidator() QuestionValidator[any]

+ func (q *Question[any]) IsQuestion() bool

+ type QuestionInterface interface

+ IsQuestion func() bool

+ type QuestionMeta struct

+ DefaultValue T

+ Multiline bool

+ Normalizer QuestionNormalizer[any]

+ Query string

+ Validator QuestionValidator[any]

+ type QuestionNormalizer func(string) T

+ type QuestionValidator func(T) (T, error)

+ type ScrollBar struct

+ func (s ScrollBar) Draw(visible []string, firstVisible string, height int, total int, width int, ...) string

+ type TextDescriptor struct

+ Output *Output

+ func (d *TextDescriptor) DescribeApplication(app *Application, options *DescriptorOptions)

+ func (d *TextDescriptor) DescribeCommand(command *Command, options *DescriptorOptions)

+ func (d *TextDescriptor) DescribeInputArgument(argument *InputArgument, options *DescriptorOptions)

+ func (d *TextDescriptor) DescribeInputDefinition(definition *InputDefinition, options *DescriptorOptions)

+ func (d *TextDescriptor) DescribeInputOption(option *InputOption, options *DescriptorOptions)

+ func (d *TextDescriptor) Write(content string, decorated bool)

+ type TrimmedBufferOutput struct

+ func (o *TrimmedBufferOutput) DoWrite(message string, newLine bool)

+ func (o *TrimmedBufferOutput) Fetch() string

v0.9.1

Aug 1, 2024

v0.9.0

Aug 1, 2024

v0.8.0

Jul 31, 2024

v0.7.1

Jul 31, 2024

v0.7.0

Jul 31, 2024

v0.6.0

Jul 31, 2024

v0.5.4

Jul 30, 2024

v0.5.3

Jul 30, 2024

v0.5.2

Jul 30, 2024

v0.5.1

Jul 30, 2024

v0.5.0

Jul 30, 2024

v0.4.4

Jul 29, 2024

v0.4.3

Jul 29, 2024

v0.4.2

Jul 29, 2024

v0.4.1

Jul 29, 2024

v0.4.0

Jul 29, 2024

v0.3.0

Jul 29, 2024

v0.2.3

Jul 28, 2024

v0.2.2

Jul 28, 2024

v0.2.1

Jul 28, 2024

v0.2.0

Jul 27, 2024

v0.1.1

Jun 23, 2024

v0.1.0

Jun 23, 2024

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