Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

tui

package module

Go to main page

Versions in this module

v1

v1.0.3

Sep 23, 2025

v1.0.2

Sep 22, 2025

Changes in this version

+ func EnsureLineBreak(out OutputChannel)

v1.0.1

Sep 22, 2025

Changes in this version

+ func AggregateMessages(out OutputChannel, messages []OutputMessage)

+ func FormatUsage(spec CommandSpec) string

+ func RegisterLegacyCommand(ctx string, cmd LegacyCommand)

+ func ResetEngine(options ...Option)

+ func SetOutputLevel(level OutputLevel)

+ func SetOutputWriter(w io.Writer) io.Writer

+ func UseMiddleware(mw ...Middleware)

+ type ArgSpec struct

+ Default any

+ Description string

+ EnumValues []string

+ Name string

+ Repeatable bool

+ Required bool

+ Type ArgType

+ type ArgType string

+ const ArgTypeBool

+ const ArgTypeDuration

+ const ArgTypeEnum

+ const ArgTypeFloat

+ const ArgTypeInt

+ const ArgTypeJSON

+ const ArgTypeString

+ type ArgsParser struct

+ func NewArgsParser() *ArgsParser

+ func (p *ArgsParser) Parse(raw []string, spec CommandSpec) (ValueSet, ValueSet, error)

type Command

+ Execute func(rt CommandRuntime, input CommandInput) CommandResult

+ Spec func() CommandSpec

+ type CommandEntry struct

+ Factory CommandFactory

+ Spec CommandSpec

+ type CommandError struct

+ Err error

+ Hints []string

+ Message string

+ Recoverable bool

+ Severity SeverityLevel

+ type CommandFactory interface

+ New func(rt CommandRuntime) (Command, error)

+ Spec func() CommandSpec

+ func NewLegacyAdapter(cmd LegacyCommand, ctx string) CommandFactory

+ type CommandInput struct

+ Args ValueSet

+ Context context.Context

+ Flags ValueSet

+ Pipeline any

+ Raw []string

+ type CommandRegistry struct

+ func NewCommandRegistry() *CommandRegistry

+ func (r *CommandRegistry) Commands(ctx string, includeHidden bool) []CommandSpec

+ func (r *CommandRegistry) Context(name string) (ContextSpec, bool)

+ func (r *CommandRegistry) Contexts(includeHidden bool) []ContextSpec

+ func (r *CommandRegistry) LoadPlugins(dir string) error

+ func (r *CommandRegistry) NamespaceCommands(namespace string) []CommandSpec

+ func (r *CommandRegistry) RegisterCommand(factory CommandFactory)

+ func (r *CommandRegistry) RegisterContext(spec ContextSpec)

+ func (r *CommandRegistry) Resolve(ctx, name string) (CommandEntry, bool)

+ func (r *CommandRegistry) ResolveContextName(name string) (string, bool)

+ func (r *CommandRegistry) UnregisterCommand(ctx, name string)

+ type CommandRegistryWriter interface

+ RegisterCommand func(factory CommandFactory)

+ RegisterContext func(spec ContextSpec)

+ type CommandResult struct

+ Error *CommandError

+ Messages []OutputMessage

+ NextContext string

+ Payload any

+ Pipeline any

+ Status CommandStatus

+ func RecoveryMiddleware(rt CommandRuntime, input CommandInput, entry CommandEntry, next NextFunc) CommandResult

+ func TimingMiddleware(rt CommandRuntime, input CommandInput, entry CommandEntry, next NextFunc) CommandResult

+ type CommandRuntime interface

+ Cancellation func() context.Context

+ ContextManager func() *ContextManager

+ NavigateTo func(name string, payload any) error

+ Output func() OutputChannel

+ PipelineData func() any

+ PopContext func() error

+ PushContext func(name string, payload any) error

+ Services func() ServiceRegistry

+ Session func() SessionStore

+ SetPipelineData func(v any)

+ TaskManager func() *TaskManager

+ type CommandSpec struct

+ Aliases []string

+ AllowPipes bool

+ Args []ArgSpec

+ Category string

+ Context string

+ DefaultAlias string

+ Description string

+ Examples []Example

+ Flags []FlagSpec

+ Hidden bool

+ Name string

+ Permissions []string

+ Summary string

+ Tags []string

+ Usage string

+ type CommandStatus string

+ const StatusFailed

+ const StatusPartial

+ const StatusPending

+ const StatusSuccess

+ type ContextManager struct

+ func NewContextManager(registry *CommandRegistry) *ContextManager

+ func (m *ContextManager) Current() ExecutionContext

+ func (m *ContextManager) Navigate(name string, payload any) error

+ func (m *ContextManager) Pop() error

+ func (m *ContextManager) PopToRoot() error

+ func (m *ContextManager) Prompt(base string) string

+ func (m *ContextManager) Push(name string, payload any) error

+ func (m *ContextManager) ResolveAliases(name string) (string, bool)

+ func (m *ContextManager) Stack() []ExecutionContext

+ type ContextOption func(*ContextSpec)

+ func WithContextAliases(aliases ...string) ContextOption

+ func WithContextPrompt(prompt string) ContextOption

+ func WithContextTags(tags ...string) ContextOption

+ type ContextSpec struct

+ Aliases []string

+ Description string

+ Hidden bool

+ Name string

+ Parent string

+ Prompt string

+ Tags []string

+ type DefaultOutputChannel struct

+ func NewOutputChannel(w io.Writer) *DefaultOutputChannel

+ func (c *DefaultOutputChannel) Buffer() *bytes.Buffer

+ func (c *DefaultOutputChannel) Error(msg string)

+ func (c *DefaultOutputChannel) Info(msg string)

+ func (c *DefaultOutputChannel) Level() OutputLevel

+ func (c *DefaultOutputChannel) SetLevel(level OutputLevel)

+ func (c *DefaultOutputChannel) Warn(msg string)

+ func (c *DefaultOutputChannel) WriteJSON(v any)

+ func (c *DefaultOutputChannel) WriteTable(headers []string, rows [][]string)

+ func (c *DefaultOutputChannel) Writer() io.Writer

+ type Engine struct

+ func DefaultEngine() *Engine

+ func NewEngine(options ...Option) *Engine

+ func (e *Engine) Contexts() *ContextManager

+ func (e *Engine) RegisterCommand(factory CommandFactory)

+ func (e *Engine) RegisterContext(spec ContextSpec)

+ func (e *Engine) Registry() *CommandRegistry

+ func (e *Engine) Run(rl *readline.Instance) error

+ func (e *Engine) Services() ServiceRegistry

+ func (e *Engine) Session() SessionStore

+ func (e *Engine) SetHelpHeader(header string)

+ func (e *Engine) SetOutputLevel(level OutputLevel)

+ func (e *Engine) SetOutputWriter(w io.Writer) io.Writer

+ func (e *Engine) SetPrompt(prompt string)

+ type Example struct

+ Command string

+ Description string

+ type ExecutionContext struct

+ Payload any

+ Spec ContextSpec

+ State map[string]any

+ type FlagSpec struct

+ Default any

+ Description string

+ EnumValues []string

+ Hidden bool

+ Name string

+ Required bool

+ Shorthand string

+ Type ArgType

+ type LegacyAdapter struct

+ func (a *LegacyAdapter) Execute(rt CommandRuntime, input CommandInput) CommandResult

+ func (a *LegacyAdapter) Spec() CommandSpec

+ type LegacyCommand interface

+ Exec func(args []string)

+ Help func() string

+ Name func() string

+ type MemorySessionStore struct

+ func NewSessionStore() *MemorySessionStore

+ func (s *MemorySessionStore) Delete(key string)

+ func (s *MemorySessionStore) Get(key string) (any, bool)

+ func (s *MemorySessionStore) Keys() []string

+ func (s *MemorySessionStore) Set(key string, value any)

+ type Middleware func(CommandRuntime, CommandInput, CommandEntry, NextFunc) CommandResult

+ type NextFunc func(CommandRuntime, CommandInput) CommandResult

+ type Option func(*Engine)

+ func WithHelpHeader(header string) Option

+ func WithMiddleware(mw ...Middleware) Option

+ func WithOutputLevel(level OutputLevel) Option

+ func WithOutputWriter(w io.Writer) Option

+ func WithPrompt(prompt string) Option

+ func WithServices(register func(ServiceRegistry)) Option

+ type OutputChannel interface

+ Buffer func() *bytes.Buffer

+ Error func(msg string)

+ Info func(msg string)

+ Level func() OutputLevel

+ SetLevel func(level OutputLevel)

+ Warn func(msg string)

+ WriteJSON func(v any)

+ WriteTable func(headers []string, rows [][]string)

+ Writer func() io.Writer

+ type OutputLevel int

+ const OutputDebug

+ const OutputNormal

+ const OutputQuiet

+ const OutputVerbose

+ type OutputMessage struct

+ Content string

+ Format string

+ Level SeverityLevel

+ type ServiceRegistry interface

+ Get func(name string) (any, bool)

+ Register func(name string, value any)

+ type SessionStore interface

+ Delete func(key string)

+ Get func(key string) (any, bool)

+ Keys func() []string

+ Set func(key string, value any)

+ type SeverityLevel string

+ const SeverityError

+ const SeverityInfo

+ const SeverityWarning

+ type SimpleServiceRegistry struct

+ func NewServiceRegistry() *SimpleServiceRegistry

+ func (r *SimpleServiceRegistry) Get(name string) (any, bool)

+ func (r *SimpleServiceRegistry) Register(name string, value any)

+ type TaskFunc func(ctx context.Context, output OutputChannel) error

+ type TaskHandle struct

+ Error error

+ ID string

+ Metadata map[string]any

+ Name string

+ Status TaskStatus

+ type TaskManager struct

+ func NewTaskManager(output OutputChannel) *TaskManager

+ func (m *TaskManager) Cancel(id string) bool

+ func (m *TaskManager) DescribeTask(id string) (*TaskHandle, bool)

+ func (m *TaskManager) SetOutputChannel(out OutputChannel)

+ func (m *TaskManager) Spawn(name string, fn TaskFunc, opts TaskOptions) *TaskHandle

+ func (m *TaskManager) Tasks() []*TaskHandle

+ type TaskOptions struct

+ Metadata map[string]any

+ Timeout time.Duration

+ type TaskStatus string

+ const TaskCancelled

+ const TaskFailed

+ const TaskPending

+ const TaskRunning

+ const TaskSucceeded

+ type ValueSet struct

+ func (v ValueSet) Bool(name string) bool

+ func (v ValueSet) DecodeJSON(name string, dest any) error

+ func (v ValueSet) Duration(name string) time.Duration

+ func (v ValueSet) Float(name string) float64

+ func (v ValueSet) Int(name string) int

+ func (v ValueSet) Raw(name string) (any, bool)

+ func (v ValueSet) String(name string) string

+ func (v ValueSet) Strings(name string) []string

v1.0.0

Sep 22, 2025

Changes in this version

+ func RegisterCommand(ctxName string, cmd Command)

+ func RegisterContext(name, description string)

+ func ResetState()

+ func Run(rl *readline.Instance)

+ func SetExitHandler(handler func()) func()

+ func SetHelpHeader(h string)

+ func SetPrompt(p string)

+ type Command interface

+ Exec func(args []string)

+ Help func() string

+ Name func() string