command

Documentation

Overview

Package command implements helpers useful for when building cobra commands.

Index

• Variables
• func FromContext(ctx context.Context) *cobra.Command
• func New(usage, short, long string, fn Runner, p ...Preparer) *cobra.Command
• func NewContext(ctx context.Context, cmd *cobra.Command) context.Context
• func RequireSession(ctx context.Context) (context.Context, error)
• func WrapRunE(fn func(*cobra.Command, []string) error) func(*cobra.Command, []string) error
• type Preparer
• type Runner

Variables

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

TODO: remove once all commands are implemented.

Functions

func FromContext

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

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

func New

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

func NewContext

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

NewContext derives a context that carries cmd from ctx.

func RequireSession

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

RequireSession is a Preparer which makes sure a session exists.

func WrapRunE

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

TODO: remove after migration is complete

Types

type Preparer

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

type Runner

type Runner func(context.Context) error