prompts

Documentation

Index

• Constants
• Variables
• func Confirm(msg string) (string, error)
• func CouponCode() (string, error)
• func CredentialAlias(creds []*mModels.Credential) (*mModels.Credential, string, string, error)
• func CreditCard() (*stripe.Token, error)
• func Email(defaultValue string) (string, error)
• func EmailVerificationCode(defaultValue string) (string, error)
• func FullName(defaultValue string) (string, error)
• func HandleSelectError(err error, generic string) error
• func InvitationCode(defaultValue string) (string, error)
• func Name(field, defaultValue string, autoSelect, allowEmpty bool) (string, error)
• func NewSpinner(suffix string) *spinner.Spinner
• func Password() (string, error)
• func ProjectDescription(defaultValue string, autoSelect bool) (string, error)
• func ResourceName(defaultValue string, autoSelect bool) (string, error)
• func SelectAPIToken(tokens []*iModels.APIToken) (*iModels.APIToken, error)
• func SelectBillingProfileAction() (string, error)
• func SelectCategory(list map[string][]*cModels.Product) (string, error)
• func SelectContext(teams []*iModels.Team, name string, userTuple *[]string) (int, string, error)
• func SelectCredential(creds []*mModels.Credential) (*mModels.Credential, string, error)
• func SelectPlan(list []*cModels.Plan, name string) (int, string, error)
• func SelectProduct(list []*cModels.Product, name string) (int, string, error)
• func SelectProject(list []*mModels.Project, name string, emptyOption, showResult bool) (int, string, error)
• func SelectProvider(list []*cModels.Provider) (*cModels.Provider, error)
• func SelectRegion(list []*cModels.Region) (int, string, error)
• func SelectResource(list []*mModels.Resource, projects []*mModels.Project, name string) (int, string, error)
• func SelectRole(roles []string) (string, error)
• func SelectTeam(teams []*iModels.Team, name string, userTuple *[]string) (int, string, error)
• func SpinStart(suffix string)
• func SpinStop()
• func TokenDescription() (string, error)

Constants

const NumberMask = '#'

NumberMask is the character used to mask number inputs

const PasswordMask = '●'

PasswordMask is the character used to mask password inputs

Variables

var IsInteractive = true

IsInteractive tells whether a terminal support interaction, such as prompts and colors.

Functions

func Confirm

func Confirm(msg string) (string, error)

Confirm is a confirmation prompt

func CouponCode

func CouponCode() (string, error)

CouponCode prompts the user to input an alphanumeric coupon code.

func CredentialAlias

func CredentialAlias(creds []*mModels.Credential) (*mModels.Credential, string, string, error)

CredentialAlias asks the user to supply a new alias for the given cred

func CreditCard

func CreditCard() (*stripe.Token, error)

CreditCard handles receiving and tokenizing payment information

func Email

func Email(defaultValue string) (string, error)

Email prompts the user to provide an email *or* accepted the default email value

func EmailVerificationCode

func EmailVerificationCode(defaultValue string) (string, error)

EmailVerificationCode prompts the user to input a person's name

func FullName

func FullName(defaultValue string) (string, error)

FullName prompts the user to input a person's name

func HandleSelectError

func HandleSelectError(err error, generic string) error

HandleSelectError returns a cli error if the error is not an EOF or Interrupt

func InvitationCode

func InvitationCode(defaultValue string) (string, error)

InvitationCode prompts the user to input an invitation token to join a team.

func Name

func Name(field, defaultValue string, autoSelect, allowEmpty bool) (string, error)

Name prompts the user to provide a Name value

func NewSpinner

func NewSpinner(suffix string) *spinner.Spinner

NewSpinner returns a customized spinner

func Password

func Password() (string, error)

Password prompts the user to input a password value

func ProjectDescription

func ProjectDescription(defaultValue string, autoSelect bool) (string, error)

ProjectDescription prompts the user to enter a project description

func ResourceName

func ResourceName(defaultValue string, autoSelect bool) (string, error)

ResourceName prompts the user to provide a label name

func SelectAPIToken

func SelectAPIToken(tokens []*iModels.APIToken) (*iModels.APIToken, error)

SelectAPIToken prompts the user to choose from a list of tokens

func SelectBillingProfileAction

func SelectBillingProfileAction() (string, error)

SelectBillingProfileAction allows the user to define their next action when encountering a paid plan without stored payment information

func SelectCategory

func SelectCategory(list map[string][]*cModels.Product) (string, error)

func SelectContext

func SelectContext(teams []*iModels.Team, name string, userTuple *[]string) (int, string, error)

SelectContext runs a SelectTeam for context purposes

func SelectCredential

func SelectCredential(creds []*mModels.Credential) (*mModels.Credential, string, error)

SelectCredential prompts the user to choose from a list of credentials

func SelectPlan

func SelectPlan(list []*cModels.Plan, name string) (int, string, error)

SelectPlan prompts the user to select a plan from the given list.

func SelectProduct

func SelectProduct(list []*cModels.Product, name string) (int, string, error)

SelectProduct prompts the user to select a product from the given list.

func SelectProject

func SelectProject(list []*mModels.Project, name string, emptyOption, showResult bool) (int, string, error)

SelectProject prompts the user to select a project from the given list.

func SelectProvider

func SelectProvider(list []*cModels.Provider) (*cModels.Provider, error)

SelectProvider prompts the user to select a provider resource from the given list.

func SelectRegion

func SelectRegion(list []*cModels.Region) (int, string, error)

SelectRegion prompts the user to select a region from the given list.

func SelectResource

func SelectResource(list []*mModels.Resource, projects []*mModels.Project,
	name string) (int, string, error)

SelectResource promps the user to select a provisioned resource from the given list

func SelectRole

func SelectRole(roles []string) (string, error)

SelectRole prompts the user to select a role from the given list.

func SelectTeam

func SelectTeam(teams []*iModels.Team, name string, userTuple *[]string) (int, string, error)

SelectTeam prompts the user to select a team from the given list. -1 as the first return value indicates no team has been selected

func SpinStart

func SpinStart(suffix string)

SpinStart starts the spinning animation for the global spinner

func SpinStop

func SpinStop()

SpinStop stopts the Spinner animation for the global spinner

func TokenDescription

func TokenDescription() (string, error)

TokenDescription prompts the user to enter a token description