prompt

Documentation

Overview

Package prompt implements input-related functionality.

Index

• Variables
• func Confirm(ctx context.Context, message string) (confirm bool, err error)
• func ConfirmOverwrite(ctx context.Context, filename string) (confirm bool, err error)
• func ConfirmYes(ctx context.Context, message string) (confirm bool, err error)
• func Confirmf(ctx context.Context, format string, a ...interface{}) (bool, error)
• func Int(ctx context.Context, dst *int, msg string, def int, required bool) error
• func IsNonInteractive(err error) bool
• func MultiRegion(ctx context.Context, msg string, splitPaid bool, currentRegions []string, ...) (*[]fly.Region, error)
• func MultiSelect(ctx context.Context, indices *[]int, msg string, def []int, options ...string) error
• func MultiSelectRegion(ctx context.Context, msg string, paid []fly.Region, regions []fly.Region, ...) (selectedRegions []fly.Region, err error)
• func Org(ctx context.Context) (*fly.Organization, error)
• func Password(ctx context.Context, dst *string, msg string, required bool) error
• func PlatformRegions(ctx context.Context) *future.Future[RegionInfo]
• func Region(ctx context.Context, splitPaid bool, params RegionParams) (*fly.Region, error)
• func Select(ctx context.Context, index *int, msg, def string, options ...string) error
• func SelectAppName(ctx context.Context) (name string, err error)
• func SelectAppNameWithMsg(ctx context.Context, msg string) (name string, err error)
• func SelectOrg(ctx context.Context, orgs []fly.Organization) (org *fly.Organization, err error)
• func SelectRegion(ctx context.Context, msg string, paid []fly.Region, regions []fly.Region, ...) (region *fly.Region, err error)
• func SelectVMSize(ctx context.Context, vmSizes []fly.VMSize) (vmSize *fly.VMSize, err error)
• func String(ctx context.Context, dst *string, msg, def string, required bool) error
• func StringWithHelp(ctx context.Context, dst *string, msg, def, help string, required bool) error
• type NonInteractiveError
  • func (e NonInteractiveError) Error() string
  • func (NonInteractiveError) Unwrap() error
• type RegionInfo
• type RegionParams

Variables

var ErrNonInteractive = errors.New("prompt: non interactive")

Functions

func Confirm

func Confirm(ctx context.Context, message string) (confirm bool, err error)

func ConfirmOverwrite

func ConfirmOverwrite(ctx context.Context, filename string) (confirm bool, err error)

func ConfirmYes

func ConfirmYes(ctx context.Context, message string) (confirm bool, err error)

func Confirmf

func Confirmf(ctx context.Context, format string, a ...interface{}) (bool, error)

func Int

func Int(ctx context.Context, dst *int, msg string, def int, required bool) error

func IsNonInteractive

func IsNonInteractive(err error) bool

func MultiRegion

func MultiRegion(ctx context.Context, msg string, splitPaid bool, currentRegions []string, excludedRegionCodes []string, flagName string) (*[]fly.Region, error)

Region returns the region the user has passed in via flag or prompts the user for one.

func MultiSelect

func MultiSelect(ctx context.Context, indices *[]int, msg string, def []int, options ...string) error

func MultiSelectRegion

func MultiSelectRegion(ctx context.Context, msg string, paid []fly.Region, regions []fly.Region, currentRegions []string) (selectedRegions []fly.Region, err error)

func Org

func Org(ctx context.Context) (*fly.Organization, error)

Org returns the Organization the user has passed in via flag or prompts the user for one.

func Password

func Password(ctx context.Context, dst *string, msg string, required bool) error

func PlatformRegions

func PlatformRegions(ctx context.Context) *future.Future[RegionInfo]

Fetches all Fly regions and app's default region. Only the first call to this function will issue an HTTP request using ctx. Subsequent calls will return the same future as the first.

func Region

func Region(ctx context.Context, splitPaid bool, params RegionParams) (*fly.Region, error)

Region returns the region the user has passed in via flag or prompts the user for one.

func Select

func Select(ctx context.Context, index *int, msg, def string, options ...string) error

func SelectAppName

func SelectAppName(ctx context.Context) (name string, err error)

func SelectAppNameWithMsg

func SelectAppNameWithMsg(ctx context.Context, msg string) (name string, err error)

func SelectOrg

func SelectOrg(ctx context.Context, orgs []fly.Organization) (org *fly.Organization, err error)

func SelectRegion

func SelectRegion(ctx context.Context, msg string, paid []fly.Region, regions []fly.Region, defaultCode string) (region *fly.Region, err error)

func SelectVMSize

func SelectVMSize(ctx context.Context, vmSizes []fly.VMSize) (vmSize *fly.VMSize, err error)

func String

func String(ctx context.Context, dst *string, msg, def string, required bool) error

func StringWithHelp

func StringWithHelp(ctx context.Context, dst *string, msg, def, help string, required bool) error

Types

type NonInteractiveError

type NonInteractiveError string

func (NonInteractiveError) Error

func (e NonInteractiveError) Error() string

func (NonInteractiveError) Unwrap

func (NonInteractiveError) Unwrap() error

type RegionInfo

type RegionInfo struct {
	Regions       []fly.Region
	DefaultRegion *fly.Region
}

type RegionParams

type RegionParams struct {
	Message             string
	ExcludedRegionCodes []string
}