cli

Documentation

Index

• func Annotate(cmd *cli.Command, meta murli.Metadata)
• func AnnotateApp(app *cli.App, meta murli.Metadata)
• func BuildV2DescribeTree(cmd *cli.Command) murli.DescribeCommandSchema
• func EmitSchema(cmd *cli.Command, w io.Writer) error
• func NewWriter(ctx *cli.Context) *murli.Writer
• func Run(app *cli.App, args []string) error
• func Wrap(app *cli.App)

Functions

func Annotate

func Annotate(cmd *cli.Command, meta murli.Metadata)

Annotate registers murli Metadata for a urfave/cli v2 command.

func AnnotateApp

func AnnotateApp(app *cli.App, meta murli.Metadata)

AnnotateApp registers murli Metadata for the root cli.App. Use this to mark root-level app flags (those on app.Flags) as Profileable.

func BuildV2DescribeTree

func BuildV2DescribeTree(cmd *cli.Command) murli.DescribeCommandSchema

BuildV2DescribeTree recursively builds the full DescribeCommandSchema for a v2 command.

func EmitSchema

func EmitSchema(cmd *cli.Command, w io.Writer) error

EmitSchema writes the agent-optimized JSON schema for a command to w.

func NewWriter

func NewWriter(ctx *cli.Context) *murli.Writer

NewWriter returns a murli Writer configured from a urfave/cli v2 context.

func Run

func Run(app *cli.App, args []string) error

Run enables murli on app and calls app.Run(args).

func Wrap

func Wrap(app *cli.App)

Wrap injects --schema and --agent flags and wraps all command Actions.