console

Documentation

Index

• Constants
• func NewApplication(name, usage, usageText, version string, artisan ...bool) console.Artisan
• type Application
  • func (c *Application) Call(command string)
  • func (c *Application) CallAndExit(command string)
  • func (c *Application) Register(commands []console.Command)
  • func (c *Application) Run(args []string, exitIfArtisan bool)
• type CliContext
  • func NewCliContext(instance *cli.Context) *CliContext
  • func (r *CliContext) Argument(index int) string
  • func (r *CliContext) Arguments() []string
  • func (r *CliContext) Ask(question string, option ...console.AskOption) (string, error)
  • func (r *CliContext) Choice(question string, choices []console.Choice, option ...console.ChoiceOption) (string, error)
  • func (r *CliContext) Comment(message string)
  • func (r *CliContext) Confirm(question string, option ...console.ConfirmOption) (bool, error)
  • func (r *CliContext) CreateProgressBar(total int) console.Progress
  • func (r *CliContext) Error(message string)
  • func (r *CliContext) Info(message string)
  • func (r *CliContext) Line(message string)
  • func (r *CliContext) MultiSelect(question string, choices []console.Choice, option ...console.MultiSelectOption) ([]string, error)
  • func (r *CliContext) NewLine(times ...int)
  • func (r *CliContext) Option(key string) string
  • func (r *CliContext) OptionBool(key string) bool
  • func (r *CliContext) OptionFloat64(key string) float64
  • func (r *CliContext) OptionFloat64Slice(key string) []float64
  • func (r *CliContext) OptionInt(key string) int
  • func (r *CliContext) OptionInt64(key string) int64
  • func (r *CliContext) OptionInt64Slice(key string) []int64
  • func (r *CliContext) OptionIntSlice(key string) []int
  • func (r *CliContext) OptionSlice(key string) []string
  • func (r *CliContext) Secret(question string, option ...console.SecretOption) (string, error)
  • func (r *CliContext) Spinner(message string, option console.SpinnerOption) error
  • func (r *CliContext) Warning(message string)
  • func (r *CliContext) WithProgressBar(items []any, callback func(any) error) ([]any, error)
• type ProgressBar
  • func NewProgressBar(total int) *ProgressBar
  • func (r *ProgressBar) Advance(step ...int)
  • func (r *ProgressBar) Finish() error
  • func (r *ProgressBar) SetTitle(message string)
  • func (r *ProgressBar) ShowElapsedTime(b ...bool) console.Progress
  • func (r *ProgressBar) ShowTitle(b ...bool) console.Progress
  • func (r *ProgressBar) Start() error
• type ServiceProvider
  • func (receiver *ServiceProvider) Boot(app foundation.Application)
  • func (receiver *ServiceProvider) Register(app foundation.Application)

Constants

const Binding = "goravel.console"

Functions

func NewApplication

func NewApplication(name, usage, usageText, version string, artisan ...bool) console.Artisan

Types

type Application

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

func (*Application) Call

func (c *Application) Call(command string)

Call Run an Artisan console command by name.

func (*Application) CallAndExit

func (c *Application) CallAndExit(command string)

CallAndExit Run an Artisan console command by name and exit.

func (*Application) Register

func (c *Application) Register(commands []console.Command)

func (*Application) Run

func (c *Application) Run(args []string, exitIfArtisan bool)

Run a command. Args come from os.Args.

type CliContext

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

func NewCliContext

func NewCliContext(instance *cli.Context) *CliContext

func (*CliContext) Argument

func (r *CliContext) Argument(index int) string

func (*CliContext) Arguments

func (r *CliContext) Arguments() []string

func (*CliContext) Ask

func (r *CliContext) Ask(question string, option ...console.AskOption) (string, error)

func (*CliContext) Choice

func (r *CliContext) Choice(question string, choices []console.Choice, option ...console.ChoiceOption) (string, error)

func (*CliContext) Comment

func (r *CliContext) Comment(message string)

func (*CliContext) Confirm

func (r *CliContext) Confirm(question string, option ...console.ConfirmOption) (bool, error)

func (*CliContext) CreateProgressBar

func (r *CliContext) CreateProgressBar(total int) console.Progress

func (*CliContext) Error

func (r *CliContext) Error(message string)

func (*CliContext) Info

func (r *CliContext) Info(message string)

func (*CliContext) Line

func (r *CliContext) Line(message string)

func (*CliContext) MultiSelect

func (r *CliContext) MultiSelect(question string, choices []console.Choice, option ...console.MultiSelectOption) ([]string, error)

func (*CliContext) NewLine

func (r *CliContext) NewLine(times ...int)

func (*CliContext) Option

func (r *CliContext) Option(key string) string

func (*CliContext) OptionBool

func (r *CliContext) OptionBool(key string) bool

func (*CliContext) OptionFloat64

func (r *CliContext) OptionFloat64(key string) float64

func (*CliContext) OptionFloat64Slice

func (r *CliContext) OptionFloat64Slice(key string) []float64

func (*CliContext) OptionInt

func (r *CliContext) OptionInt(key string) int

func (*CliContext) OptionInt64

func (r *CliContext) OptionInt64(key string) int64

func (*CliContext) OptionInt64Slice

func (r *CliContext) OptionInt64Slice(key string) []int64

func (*CliContext) OptionIntSlice

func (r *CliContext) OptionIntSlice(key string) []int

func (*CliContext) OptionSlice

func (r *CliContext) OptionSlice(key string) []string

func (*CliContext) Secret

func (r *CliContext) Secret(question string, option ...console.SecretOption) (string, error)

func (*CliContext) Spinner

func (r *CliContext) Spinner(message string, option console.SpinnerOption) error

func (*CliContext) Warning

func (r *CliContext) Warning(message string)

func (*CliContext) WithProgressBar

func (r *CliContext) WithProgressBar(items []any, callback func(any) error) ([]any, error)

type ProgressBar

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

func NewProgressBar

func NewProgressBar(total int) *ProgressBar

func (*ProgressBar) Advance

func (r *ProgressBar) Advance(step ...int)

func (*ProgressBar) Finish

func (r *ProgressBar) Finish() error

func (*ProgressBar) SetTitle

func (r *ProgressBar) SetTitle(message string)

func (*ProgressBar) ShowElapsedTime

func (r *ProgressBar) ShowElapsedTime(b ...bool) console.Progress

func (*ProgressBar) ShowTitle

func (r *ProgressBar) ShowTitle(b ...bool) console.Progress

func (*ProgressBar) Start

func (r *ProgressBar) Start() error

type ServiceProvider

type ServiceProvider struct {
}

func (*ServiceProvider) Boot

func (receiver *ServiceProvider) Boot(app foundation.Application)

func (*ServiceProvider) Register

func (receiver *ServiceProvider) Register(app foundation.Application)