command

Documentation

Overview

Package command contains utilities for creating system-probe commands

Index

• func MakeCommand(subcommandFactories []SubcommandFactory) *cobra.Command
• func SetDefaultCommandIfNonePresent(rootCmd *cobra.Command)
• type GlobalParams
• type SubcommandFactory

Functions

func MakeCommand

func MakeCommand(subcommandFactories []SubcommandFactory) *cobra.Command

MakeCommand makes the top-level Cobra command for this app.

func SetDefaultCommandIfNonePresent

func SetDefaultCommandIfNonePresent(rootCmd *cobra.Command)

SetDefaultCommandIfNonePresent sets the "run" subcommand as root command to support the legacy (without any command) invocation.

Types

type GlobalParams

type GlobalParams struct {
	// ConfFilePath holds the path to the folder containing the configuration
	// file, to allow overrides from the command line
	ConfFilePath string
}

GlobalParams contains the values of system-probe global Cobra flags.

A pointer to this type is passed to SubcommandFactory's, but its contents are not valid until Cobra calls the subcommand's Run or RunE function.

type SubcommandFactory

type SubcommandFactory func(globalParams *GlobalParams) []*cobra.Command

SubcommandFactory is a callable that will return a slice of subcommands.