Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

console

package

Go to main page

Versions in this module

v1

v1.14.7

Sep 19, 2024

v1.14.6

Sep 12, 2024

v1.14.5

Sep 7, 2024

v1.14.4

Jul 20, 2024

v1.14.3

Jul 8, 2024

v1.14.2

Jul 3, 2024

v1.14.1

Jun 13, 2024

v1.14.0

Jun 7, 2024

Changes in this version

+ type Artisan struct

+ func NewArtisan(t interface{ ... }) *Artisan

+ func (_m *Artisan) Call(command string)

+ func (_m *Artisan) CallAndExit(command string)

+ func (_m *Artisan) EXPECT() *Artisan_Expecter

+ func (_m *Artisan) Register(commands []console.Command)

+ func (_m *Artisan) Run(args []string, exitIfArtisan bool)

+ type Artisan_CallAndExit_Call struct

+ func (_c *Artisan_CallAndExit_Call) Return() *Artisan_CallAndExit_Call

+ func (_c *Artisan_CallAndExit_Call) Run(run func(command string)) *Artisan_CallAndExit_Call

+ func (_c *Artisan_CallAndExit_Call) RunAndReturn(run func(string)) *Artisan_CallAndExit_Call

+ type Artisan_Call_Call struct

+ func (_c *Artisan_Call_Call) Return() *Artisan_Call_Call

+ func (_c *Artisan_Call_Call) Run(run func(command string)) *Artisan_Call_Call

+ func (_c *Artisan_Call_Call) RunAndReturn(run func(string)) *Artisan_Call_Call

+ type Artisan_Expecter struct

+ func (_e *Artisan_Expecter) Call(command interface{}) *Artisan_Call_Call

+ func (_e *Artisan_Expecter) CallAndExit(command interface{}) *Artisan_CallAndExit_Call

+ func (_e *Artisan_Expecter) Register(commands interface{}) *Artisan_Register_Call

+ func (_e *Artisan_Expecter) Run(args interface{}, exitIfArtisan interface{}) *Artisan_Run_Call

+ type Artisan_Register_Call struct

+ func (_c *Artisan_Register_Call) Return() *Artisan_Register_Call

+ func (_c *Artisan_Register_Call) Run(run func(commands []console.Command)) *Artisan_Register_Call

+ func (_c *Artisan_Register_Call) RunAndReturn(run func([]console.Command)) *Artisan_Register_Call

+ type Artisan_Run_Call struct

+ func (_c *Artisan_Run_Call) Return() *Artisan_Run_Call

+ func (_c *Artisan_Run_Call) Run(run func(args []string, exitIfArtisan bool)) *Artisan_Run_Call

+ func (_c *Artisan_Run_Call) RunAndReturn(run func([]string, bool)) *Artisan_Run_Call

+ type Command struct

+ func NewCommand(t interface{ ... }) *Command

+ func (_m *Command) Description() string

+ func (_m *Command) EXPECT() *Command_Expecter

+ func (_m *Command) Extend() command.Extend

+ func (_m *Command) Handle(ctx console.Context) error

+ func (_m *Command) Signature() string

+ type Command_Description_Call struct

+ func (_c *Command_Description_Call) Return(_a0 string) *Command_Description_Call

+ func (_c *Command_Description_Call) Run(run func()) *Command_Description_Call

+ func (_c *Command_Description_Call) RunAndReturn(run func() string) *Command_Description_Call

+ type Command_Expecter struct

+ func (_e *Command_Expecter) Description() *Command_Description_Call

+ func (_e *Command_Expecter) Extend() *Command_Extend_Call

+ func (_e *Command_Expecter) Handle(ctx interface{}) *Command_Handle_Call

+ func (_e *Command_Expecter) Signature() *Command_Signature_Call

+ type Command_Extend_Call struct

+ func (_c *Command_Extend_Call) Return(_a0 command.Extend) *Command_Extend_Call

+ func (_c *Command_Extend_Call) Run(run func()) *Command_Extend_Call

+ func (_c *Command_Extend_Call) RunAndReturn(run func() command.Extend) *Command_Extend_Call

+ type Command_Handle_Call struct

+ func (_c *Command_Handle_Call) Return(_a0 error) *Command_Handle_Call

+ func (_c *Command_Handle_Call) Run(run func(ctx console.Context)) *Command_Handle_Call

+ func (_c *Command_Handle_Call) RunAndReturn(run func(console.Context) error) *Command_Handle_Call

+ type Command_Signature_Call struct

+ func (_c *Command_Signature_Call) Return(_a0 string) *Command_Signature_Call

+ func (_c *Command_Signature_Call) Run(run func()) *Command_Signature_Call

+ func (_c *Command_Signature_Call) RunAndReturn(run func() string) *Command_Signature_Call

+ type Context struct

+ func NewContext(t interface{ ... }) *Context

+ func (_m *Context) Argument(index int) string

+ func (_m *Context) Arguments() []string

+ func (_m *Context) Ask(question string, option ...console.AskOption) (string, error)

+ func (_m *Context) Choice(question string, options []console.Choice, option ...console.ChoiceOption) (string, error)

+ func (_m *Context) Comment(message string)

+ func (_m *Context) Confirm(question string, option ...console.ConfirmOption) (bool, error)

+ func (_m *Context) CreateProgressBar(total int) console.Progress

+ func (_m *Context) EXPECT() *Context_Expecter

+ func (_m *Context) Error(message string)

+ func (_m *Context) Info(message string)

+ func (_m *Context) Line(message string)

+ func (_m *Context) MultiSelect(question string, options []console.Choice, option ...console.MultiSelectOption) ([]string, error)

+ func (_m *Context) NewLine(times ...int)

+ func (_m *Context) Option(key string) string

+ func (_m *Context) OptionBool(key string) bool

+ func (_m *Context) OptionFloat64(key string) float64

+ func (_m *Context) OptionFloat64Slice(key string) []float64

+ func (_m *Context) OptionInt(key string) int

+ func (_m *Context) OptionInt64(key string) int64

+ func (_m *Context) OptionInt64Slice(key string) []int64

+ func (_m *Context) OptionIntSlice(key string) []int

+ func (_m *Context) OptionSlice(key string) []string

+ func (_m *Context) Secret(question string, option ...console.SecretOption) (string, error)

+ func (_m *Context) Spinner(message string, option console.SpinnerOption) error

+ func (_m *Context) Warning(message string)

+ func (_m *Context) WithProgressBar(items []interface{}, callback func(interface{}) error) ([]interface{}, error)

+ type Context_Argument_Call struct

+ func (_c *Context_Argument_Call) Return(_a0 string) *Context_Argument_Call

+ func (_c *Context_Argument_Call) Run(run func(index int)) *Context_Argument_Call

+ func (_c *Context_Argument_Call) RunAndReturn(run func(int) string) *Context_Argument_Call

+ type Context_Arguments_Call struct

+ func (_c *Context_Arguments_Call) Return(_a0 []string) *Context_Arguments_Call

+ func (_c *Context_Arguments_Call) Run(run func()) *Context_Arguments_Call

+ func (_c *Context_Arguments_Call) RunAndReturn(run func() []string) *Context_Arguments_Call

+ type Context_Ask_Call struct

+ func (_c *Context_Ask_Call) Return(_a0 string, _a1 error) *Context_Ask_Call

+ func (_c *Context_Ask_Call) Run(run func(question string, option ...console.AskOption)) *Context_Ask_Call

+ func (_c *Context_Ask_Call) RunAndReturn(run func(string, ...console.AskOption) (string, error)) *Context_Ask_Call

+ type Context_Choice_Call struct

+ func (_c *Context_Choice_Call) Return(_a0 string, _a1 error) *Context_Choice_Call

+ func (_c *Context_Choice_Call) Run(...) *Context_Choice_Call

+ func (_c *Context_Choice_Call) RunAndReturn(run func(string, []console.Choice, ...console.ChoiceOption) (string, error)) *Context_Choice_Call

+ type Context_Comment_Call struct

+ func (_c *Context_Comment_Call) Return() *Context_Comment_Call

+ func (_c *Context_Comment_Call) Run(run func(message string)) *Context_Comment_Call

+ func (_c *Context_Comment_Call) RunAndReturn(run func(string)) *Context_Comment_Call

+ type Context_Confirm_Call struct

+ func (_c *Context_Confirm_Call) Return(_a0 bool, _a1 error) *Context_Confirm_Call

+ func (_c *Context_Confirm_Call) Run(run func(question string, option ...console.ConfirmOption)) *Context_Confirm_Call

+ func (_c *Context_Confirm_Call) RunAndReturn(run func(string, ...console.ConfirmOption) (bool, error)) *Context_Confirm_Call

+ type Context_CreateProgressBar_Call struct

+ func (_c *Context_CreateProgressBar_Call) Return(_a0 console.Progress) *Context_CreateProgressBar_Call

+ func (_c *Context_CreateProgressBar_Call) Run(run func(total int)) *Context_CreateProgressBar_Call

+ func (_c *Context_CreateProgressBar_Call) RunAndReturn(run func(int) console.Progress) *Context_CreateProgressBar_Call

+ type Context_Error_Call struct

+ func (_c *Context_Error_Call) Return() *Context_Error_Call

+ func (_c *Context_Error_Call) Run(run func(message string)) *Context_Error_Call

+ func (_c *Context_Error_Call) RunAndReturn(run func(string)) *Context_Error_Call

+ type Context_Expecter struct

+ func (_e *Context_Expecter) Argument(index interface{}) *Context_Argument_Call

+ func (_e *Context_Expecter) Arguments() *Context_Arguments_Call

+ func (_e *Context_Expecter) Ask(question interface{}, option ...interface{}) *Context_Ask_Call

+ func (_e *Context_Expecter) Choice(question interface{}, options interface{}, option ...interface{}) *Context_Choice_Call

+ func (_e *Context_Expecter) Comment(message interface{}) *Context_Comment_Call

+ func (_e *Context_Expecter) Confirm(question interface{}, option ...interface{}) *Context_Confirm_Call

+ func (_e *Context_Expecter) CreateProgressBar(total interface{}) *Context_CreateProgressBar_Call

+ func (_e *Context_Expecter) Error(message interface{}) *Context_Error_Call

+ func (_e *Context_Expecter) Info(message interface{}) *Context_Info_Call

+ func (_e *Context_Expecter) Line(message interface{}) *Context_Line_Call

+ func (_e *Context_Expecter) MultiSelect(question interface{}, options interface{}, option ...interface{}) *Context_MultiSelect_Call

+ func (_e *Context_Expecter) NewLine(times ...interface{}) *Context_NewLine_Call

+ func (_e *Context_Expecter) Option(key interface{}) *Context_Option_Call

+ func (_e *Context_Expecter) OptionBool(key interface{}) *Context_OptionBool_Call

+ func (_e *Context_Expecter) OptionFloat64(key interface{}) *Context_OptionFloat64_Call

+ func (_e *Context_Expecter) OptionFloat64Slice(key interface{}) *Context_OptionFloat64Slice_Call

+ func (_e *Context_Expecter) OptionInt(key interface{}) *Context_OptionInt_Call

+ func (_e *Context_Expecter) OptionInt64(key interface{}) *Context_OptionInt64_Call

+ func (_e *Context_Expecter) OptionInt64Slice(key interface{}) *Context_OptionInt64Slice_Call

+ func (_e *Context_Expecter) OptionIntSlice(key interface{}) *Context_OptionIntSlice_Call

+ func (_e *Context_Expecter) OptionSlice(key interface{}) *Context_OptionSlice_Call

+ func (_e *Context_Expecter) Secret(question interface{}, option ...interface{}) *Context_Secret_Call

+ func (_e *Context_Expecter) Spinner(message interface{}, option interface{}) *Context_Spinner_Call

+ func (_e *Context_Expecter) Warning(message interface{}) *Context_Warning_Call

+ func (_e *Context_Expecter) WithProgressBar(items interface{}, callback interface{}) *Context_WithProgressBar_Call

+ type Context_Info_Call struct

+ func (_c *Context_Info_Call) Return() *Context_Info_Call

+ func (_c *Context_Info_Call) Run(run func(message string)) *Context_Info_Call

+ func (_c *Context_Info_Call) RunAndReturn(run func(string)) *Context_Info_Call

+ type Context_Line_Call struct

+ func (_c *Context_Line_Call) Return() *Context_Line_Call

+ func (_c *Context_Line_Call) Run(run func(message string)) *Context_Line_Call

+ func (_c *Context_Line_Call) RunAndReturn(run func(string)) *Context_Line_Call

+ type Context_MultiSelect_Call struct

+ func (_c *Context_MultiSelect_Call) Return(_a0 []string, _a1 error) *Context_MultiSelect_Call

+ func (_c *Context_MultiSelect_Call) Run(...) *Context_MultiSelect_Call

+ func (_c *Context_MultiSelect_Call) RunAndReturn(...) *Context_MultiSelect_Call

+ type Context_NewLine_Call struct

+ func (_c *Context_NewLine_Call) Return() *Context_NewLine_Call

+ func (_c *Context_NewLine_Call) Run(run func(times ...int)) *Context_NewLine_Call

+ func (_c *Context_NewLine_Call) RunAndReturn(run func(...int)) *Context_NewLine_Call

+ type Context_OptionBool_Call struct

+ func (_c *Context_OptionBool_Call) Return(_a0 bool) *Context_OptionBool_Call

+ func (_c *Context_OptionBool_Call) Run(run func(key string)) *Context_OptionBool_Call

+ func (_c *Context_OptionBool_Call) RunAndReturn(run func(string) bool) *Context_OptionBool_Call

+ type Context_OptionFloat64Slice_Call struct

+ func (_c *Context_OptionFloat64Slice_Call) Return(_a0 []float64) *Context_OptionFloat64Slice_Call

+ func (_c *Context_OptionFloat64Slice_Call) Run(run func(key string)) *Context_OptionFloat64Slice_Call

+ func (_c *Context_OptionFloat64Slice_Call) RunAndReturn(run func(string) []float64) *Context_OptionFloat64Slice_Call

+ type Context_OptionFloat64_Call struct

+ func (_c *Context_OptionFloat64_Call) Return(_a0 float64) *Context_OptionFloat64_Call

+ func (_c *Context_OptionFloat64_Call) Run(run func(key string)) *Context_OptionFloat64_Call

+ func (_c *Context_OptionFloat64_Call) RunAndReturn(run func(string) float64) *Context_OptionFloat64_Call

+ type Context_OptionInt64Slice_Call struct

+ func (_c *Context_OptionInt64Slice_Call) Return(_a0 []int64) *Context_OptionInt64Slice_Call

+ func (_c *Context_OptionInt64Slice_Call) Run(run func(key string)) *Context_OptionInt64Slice_Call

+ func (_c *Context_OptionInt64Slice_Call) RunAndReturn(run func(string) []int64) *Context_OptionInt64Slice_Call

+ type Context_OptionInt64_Call struct

+ func (_c *Context_OptionInt64_Call) Return(_a0 int64) *Context_OptionInt64_Call

+ func (_c *Context_OptionInt64_Call) Run(run func(key string)) *Context_OptionInt64_Call

+ func (_c *Context_OptionInt64_Call) RunAndReturn(run func(string) int64) *Context_OptionInt64_Call

+ type Context_OptionIntSlice_Call struct

+ func (_c *Context_OptionIntSlice_Call) Return(_a0 []int) *Context_OptionIntSlice_Call

+ func (_c *Context_OptionIntSlice_Call) Run(run func(key string)) *Context_OptionIntSlice_Call

+ func (_c *Context_OptionIntSlice_Call) RunAndReturn(run func(string) []int) *Context_OptionIntSlice_Call

+ type Context_OptionInt_Call struct

+ func (_c *Context_OptionInt_Call) Return(_a0 int) *Context_OptionInt_Call

+ func (_c *Context_OptionInt_Call) Run(run func(key string)) *Context_OptionInt_Call

+ func (_c *Context_OptionInt_Call) RunAndReturn(run func(string) int) *Context_OptionInt_Call

+ type Context_OptionSlice_Call struct

+ func (_c *Context_OptionSlice_Call) Return(_a0 []string) *Context_OptionSlice_Call

+ func (_c *Context_OptionSlice_Call) Run(run func(key string)) *Context_OptionSlice_Call

+ func (_c *Context_OptionSlice_Call) RunAndReturn(run func(string) []string) *Context_OptionSlice_Call

+ type Context_Option_Call struct

+ func (_c *Context_Option_Call) Return(_a0 string) *Context_Option_Call

+ func (_c *Context_Option_Call) Run(run func(key string)) *Context_Option_Call

+ func (_c *Context_Option_Call) RunAndReturn(run func(string) string) *Context_Option_Call

+ type Context_Secret_Call struct

+ func (_c *Context_Secret_Call) Return(_a0 string, _a1 error) *Context_Secret_Call

+ func (_c *Context_Secret_Call) Run(run func(question string, option ...console.SecretOption)) *Context_Secret_Call

+ func (_c *Context_Secret_Call) RunAndReturn(run func(string, ...console.SecretOption) (string, error)) *Context_Secret_Call

+ type Context_Spinner_Call struct

+ func (_c *Context_Spinner_Call) Return(_a0 error) *Context_Spinner_Call

+ func (_c *Context_Spinner_Call) Run(run func(message string, option console.SpinnerOption)) *Context_Spinner_Call

+ func (_c *Context_Spinner_Call) RunAndReturn(run func(string, console.SpinnerOption) error) *Context_Spinner_Call

+ type Context_Warning_Call struct

+ func (_c *Context_Warning_Call) Return() *Context_Warning_Call

+ func (_c *Context_Warning_Call) Run(run func(message string)) *Context_Warning_Call

+ func (_c *Context_Warning_Call) RunAndReturn(run func(string)) *Context_Warning_Call

+ type Context_WithProgressBar_Call struct

+ func (_c *Context_WithProgressBar_Call) Return(_a0 []interface{}, _a1 error) *Context_WithProgressBar_Call

+ func (_c *Context_WithProgressBar_Call) Run(run func(items []interface{}, callback func(interface{}) error)) *Context_WithProgressBar_Call

+ func (_c *Context_WithProgressBar_Call) RunAndReturn(run func([]interface{}, func(interface{}) error) ([]interface{}, error)) *Context_WithProgressBar_Call

+ type Progress struct

+ func NewProgress(t interface{ ... }) *Progress

+ func (_m *Progress) Advance(step ...int)

+ func (_m *Progress) EXPECT() *Progress_Expecter

+ func (_m *Progress) Finish() error

+ func (_m *Progress) SetTitle(message string)

+ func (_m *Progress) ShowElapsedTime(b ...bool) console.Progress

+ func (_m *Progress) ShowTitle(b ...bool) console.Progress

+ func (_m *Progress) Start() error

+ type Progress_Advance_Call struct

+ func (_c *Progress_Advance_Call) Return() *Progress_Advance_Call

+ func (_c *Progress_Advance_Call) Run(run func(step ...int)) *Progress_Advance_Call

+ func (_c *Progress_Advance_Call) RunAndReturn(run func(...int)) *Progress_Advance_Call

+ type Progress_Expecter struct

+ func (_e *Progress_Expecter) Advance(step ...interface{}) *Progress_Advance_Call

+ func (_e *Progress_Expecter) Finish() *Progress_Finish_Call

+ func (_e *Progress_Expecter) SetTitle(message interface{}) *Progress_SetTitle_Call

+ func (_e *Progress_Expecter) ShowElapsedTime(b ...interface{}) *Progress_ShowElapsedTime_Call

+ func (_e *Progress_Expecter) ShowTitle(b ...interface{}) *Progress_ShowTitle_Call

+ func (_e *Progress_Expecter) Start() *Progress_Start_Call

+ type Progress_Finish_Call struct

+ func (_c *Progress_Finish_Call) Return(_a0 error) *Progress_Finish_Call

+ func (_c *Progress_Finish_Call) Run(run func()) *Progress_Finish_Call

+ func (_c *Progress_Finish_Call) RunAndReturn(run func() error) *Progress_Finish_Call

+ type Progress_SetTitle_Call struct

+ func (_c *Progress_SetTitle_Call) Return() *Progress_SetTitle_Call

+ func (_c *Progress_SetTitle_Call) Run(run func(message string)) *Progress_SetTitle_Call

+ func (_c *Progress_SetTitle_Call) RunAndReturn(run func(string)) *Progress_SetTitle_Call

+ type Progress_ShowElapsedTime_Call struct

+ func (_c *Progress_ShowElapsedTime_Call) Return(_a0 console.Progress) *Progress_ShowElapsedTime_Call

+ func (_c *Progress_ShowElapsedTime_Call) Run(run func(b ...bool)) *Progress_ShowElapsedTime_Call

+ func (_c *Progress_ShowElapsedTime_Call) RunAndReturn(run func(...bool) console.Progress) *Progress_ShowElapsedTime_Call

+ type Progress_ShowTitle_Call struct

+ func (_c *Progress_ShowTitle_Call) Return(_a0 console.Progress) *Progress_ShowTitle_Call

+ func (_c *Progress_ShowTitle_Call) Run(run func(b ...bool)) *Progress_ShowTitle_Call

+ func (_c *Progress_ShowTitle_Call) RunAndReturn(run func(...bool) console.Progress) *Progress_ShowTitle_Call

+ type Progress_Start_Call struct

+ func (_c *Progress_Start_Call) Return(_a0 error) *Progress_Start_Call

+ func (_c *Progress_Start_Call) Run(run func()) *Progress_Start_Call

+ func (_c *Progress_Start_Call) RunAndReturn(run func() error) *Progress_Start_Call