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

wizard

package module

Go to main page

Versions in this module

v0

v0.3.0

Mar 15, 2026

Changes in this version

+ func CleanupDrafts(targetPath string) error

+ func DefaultRunSteps(steps []Step) error

+ func DraftTargetToken(targetPath string) string

+ func DrainStdin()

+ func LatestDraftForTarget(targetPath string) string

+ func LoadDraftYAML(draftPath string, out any) (bool, error)

+ func MultiSelectHint() string

+ func RestoreTTY()

+ func WriteDraft(targetPath string, plaintext []byte) (string, error)

type Selector

+ func (s *Selector) Confirm(message string, defaultYes bool) bool

+ func (s *Selector) MultiSelect(items []string, defaults []string, message string) []string

v0.2.3

Mar 10, 2026

Changes in this version

+ func IsPlaceholderValue(v any) bool

type ReconcileOptions

+ CheckPlaceholders bool

type ReconcileReport

+ PlaceholderValues []string

v0.2.2

Mar 9, 2026

v0.2.1

Mar 8, 2026

Changes in this version

+ const ANSICyan

+ const ANSIRed

+ const ANSIReset

+ const ANSIYellow

+ var ErrInterrupted = errors.New("wizard interrupted")

+ func ActionVerb(text string) string

+ func BackLabel() string

+ func BackMenuLabel(width int) string

+ func Colorize(text, color string) string

+ func ErrorHint(err error) string

+ func ExitLabel() string

+ func ExitMenuLabel(width int) string

+ func FormatActionLabel(text string, verbWidth int) string

+ func FormatCLIError(err error) string

+ func FormatMenuLabel(tag, text string, width int) string

+ func IsBackChoice(value string) bool

+ func IsCancelChoice(value string) bool

+ func IsExitChoice(value string) bool

+ func IsInterrupted(err error) bool

+ func NewUserError(message, hint string) error

+ func NormalizeChoice(value string) string

+ func RunSteps(steps []Step, onStepStart func(index, total int, name string), ...) error

+ func SelectHint() string

+ func WithHint(err error, hint string) error

+ type ManageAction string

+ const ManageCancel

+ const ManageCreate

+ const ManageDelete

+ const ManageEdit

+ const ManageSetDefault

+ type ManageOptions struct

+ CancelLabel string

+ CreateLabel string

+ DefaultLabel string

+ DeleteLabel string

+ EditLabel string

+ ItemLabel func(item T) string

+ ItemMessage string

+ Items []T

+ MainMessage string

+ Select func(options []string, defaultOption, message string) string

+ SetDefaultLbl string

+ type ManageSelection struct

+ Action ManageAction

+ Item *T

+ func Manage[T any](opts ManageOptions[T]) (ManageSelection[T], error)

+ type ReconcileOptions struct

+ DropUnknown bool

+ RequiredPaths []string

+ type ReconcileReport struct

+ Added []string

+ MissingRequired []string

+ Removed []string

+ func ReconcileWithTemplate(current, template map[string]any, opts ReconcileOptions) (map[string]any, ReconcileReport, error)

+ type Selector struct

+ MaxVisible int

+ func NewSelector() *Selector

+ func (s *Selector) Select(items []string, defaultItem, message string) string

+ func (s *Selector) WasInterrupted() bool

+ type Session struct

+ DraftPath string

+ IsEmpty func() bool

+ State any

+ TargetPath string

+ func NewSession(targetPath, draftPath string, state any, isEmpty func() bool, ...) *Session

+ func (s *Session) Finalize() error

+ func (s *Session) LoadDraft() (bool, error)

+ func (s *Session) Start()

+ func (s *Session) Stop()

+ type Step struct

+ Name string

+ Run func() error

+ type UserError struct

+ HintMsg string

+ Message string

+ func (e *UserError) Error() string

+ func (e *UserError) Hint() string