cmdutil

Documentation

Index

• func ConfirmPrompt(msg, help string, def bool) (bool, error)
• func InputPrompt(msg, def string) (string, error)
• func RepoForProjectPath(path string) (drivers.RepoStore, string, error)
• func SelectPrompt(msg string, options []string, def string) (string, error)
• func SelectPromptIfEmpty(input *string, msg string, options []string, def string) error
• func SetFlagsByInputPrompts(cmd cobra.Command, flags ...string) error
• func StringPromptIfEmpty(input *string, msg string) error
• type Helper
  • func (h *Helper) AdminToken() string
  • func (h *Helper) Client() (*client.Client, error)
  • func (h *Helper) Close() error
  • func (h *Helper) CurrentUserID(ctx context.Context) (string, error)
  • func (h *Helper) InferProjectName(ctx context.Context, org, path string) (string, error)
  • func (h *Helper) IsAuthenticated() bool
  • func (h *Helper) IsDev() bool
  • func (h *Helper) ProjectNamesByGithubURL(ctx context.Context, org, githubURL string) ([]string, error)
  • func (h *Helper) Telemetry(ctx context.Context) *activity.Client
• type PreRunCheck
  • func CheckAuth(ch *Helper) PreRunCheck
  • func CheckChain(chain ...PreRunCheck) PreRunCheck
  • func CheckOrganization(ch *Helper) PreRunCheck
• type Version
  • func (v Version) IsDev() bool
  • func (v Version) String() string

Functions

func ConfirmPrompt

func ConfirmPrompt(msg, help string, def bool) (bool, error)

func InputPrompt

func InputPrompt(msg, def string) (string, error)

func RepoForProjectPath

func RepoForProjectPath(path string) (drivers.RepoStore, string, error)

RepoForProjectPath creates an ad-hoc drivers.RepoStore for a local project file path

func SelectPrompt

func SelectPrompt(msg string, options []string, def string) (string, error)

func SelectPromptIfEmpty

func SelectPromptIfEmpty(input *string, msg string, options []string, def string) error

func SetFlagsByInputPrompts

func SetFlagsByInputPrompts(cmd cobra.Command, flags ...string) error

func StringPromptIfEmpty

func StringPromptIfEmpty(input *string, msg string) error

Types

type Helper

type Helper struct {
	*printer.Printer
	Version            Version
	AdminURL           string
	AdminTokenOverride string
	AdminTokenDefault  string
	Org                string
	Interactive        bool
	// contains filtered or unexported fields
}

func (*Helper) AdminToken

func (h *Helper) AdminToken() string

func (*Helper) Client

func (h *Helper) Client() (*client.Client, error)

func (*Helper) Close

func (h *Helper) Close() error

func (*Helper) CurrentUserID

func (h *Helper) CurrentUserID(ctx context.Context) (string, error)

CurrentUser fetches the ID of the current user. It caches the result in ~/.rill, along with a hash of the current admin token for cache invalidation in case of login/logout.

func (*Helper) InferProjectName

func (h *Helper) InferProjectName(ctx context.Context, org, path string) (string, error)

func (*Helper) IsAuthenticated

func (h *Helper) IsAuthenticated() bool

func (*Helper) IsDev

func (h *Helper) IsDev() bool

func (*Helper) ProjectNamesByGithubURL

func (h *Helper) ProjectNamesByGithubURL(ctx context.Context, org, githubURL string) ([]string, error)

func (*Helper) Telemetry

func (h *Helper) Telemetry(ctx context.Context) *activity.Client

Telemetry returns a client for recording events. Note: It should only be used for parts of the CLI that run on users' local computer because: a) it accesses ~/.rill and adds information about the current user, b) it sends events to the public intake endpoint instead of directly to Kafka.

type PreRunCheck

type PreRunCheck func(cmd *cobra.Command, args []string) error

func CheckAuth

func CheckAuth(ch *Helper) PreRunCheck

func CheckChain

func CheckChain(chain ...PreRunCheck) PreRunCheck

func CheckOrganization

func CheckOrganization(ch *Helper) PreRunCheck

type Version

type Version struct {
	Number    string
	Commit    string
	Timestamp string
}

func (Version) IsDev

func (v Version) IsDev() bool

func (Version) String

func (v Version) String() string