command

package

v0.0.251 Latest Latest Go to latest Published: Nov 8, 2021 License: Apache-2.0 Imports: 25 Imported by: 0

Details

Package command implements helpers useful for when building cobra commands.

This section is empty.

View Source

var ErrNotImplementedYet = errors.New("command not implemented yet")

TODO: remove once all commands are implemented.

func FromContext(ctx context.Context) *cobra.Command

FromContext returns the Command ctx carries. It panics in case ctx carries no Command.

func FromDocstrings(dsk string, fn Runner, p ...Preparer) *cobra.Command

func New(usage, short, long string, fn Runner, p ...Preparer) *cobra.Command

func NewContext(ctx context.Context, cmd *cobra.Command) context.Context

NewContext derives a context that carries cmd from ctx.

func RequireOrg(ctx context.Context) (context.Context, error)

RequireOrg is a Preparer which makes sure the user has selected an organization. It embeds RequireSession.

func RequireSession(ctx context.Context) (context.Context, error)

RequireSession is a Preparer which makes sure a session exists.

func WrapRunE(fn func(*cobra.Command, []string) error) func(*cobra.Command, []string) error

TODO: remove after migration is complete

type Preparer func(context.Context) (context.Context, error)

type Runner func(context.Context) error

Path	Synopsis
apps Package apps implements the apps command chain.	Package apps implements the apps command chain.
root Package root implements the root command.	Package root implements the root command.
version Package version implements the version command chain.	Package version implements the version command chain.