app

Documentation

Overview

Package app provides the root command for the minder CLI

Index

• Constants
• Variables
• func Execute()
• func IsOutputFormatSupported(output string) bool
• func SupportedOutputFormats() []string

Constants

const (
	// JSON is the json format for output
	JSON = "json"
	// YAML is the yaml format for output
	YAML = "yaml"
	// Table is the table format for output
	Table = "table"
)

Variables

var (
	// RootCmd represents the base command when called without any subcommands
	RootCmd = &cobra.Command{
		Use:   "minder",
		Short: "Minder controls the hosted minder service",
		Long: `For more information about minder, please visit:
https://docs.stacklok.com/minder`,
		SilenceErrors: true,
		PersistentPreRunE: func(cmd *cobra.Command, _ []string) error {

			cfg, _ := config.ReadConfigFromViper[clientconfig.Config](viper.GetViper())

			if cfg == nil || cfg.GRPCClientConfig.Host != constants.MinderGRPCHost {
				fmt.Fprintf(
					cmd.ErrOrStderr(),
					"WARNING: Running against a test environment (%s) and may not be stable\n",
					cfg.GRPCClientConfig.Host)
			}
			return nil
		},
	}

	// ConfigHelpCmd is a "help topic", which is represented as a command with no "Run" function.
	// See https://github.com/spf13/cobra/issues/393#issuecomment-282741924 and
	// https://pkg.go.dev/github.com/spf13/cobra#Command.IsAdditionalHelpTopicCommand
	//nolint:lll
	ConfigHelpCmd = &cobra.Command{
		Use:    "config",
		Short:  "How to manage minder CLI configuration",
		Hidden: true,
		Long: `In addition to the command-line flags, many minder options can be set via a configuration file in the YAML format.

Configuration options include:
- provider
- project
- output
- grpc_server.host
- grpc_server.port
- grpc_server.insecure
- identity.cli.issuer_url
- identity.cli.client_id

By default, we look for the file as $PWD/config.yaml and $XDG_CONFIG_PATH/minder/config.yaml. You can specify a custom path via the --config flag, or by setting the MINDER_CONFIG environment variable.`,
	}
)

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately.

func IsOutputFormatSupported

func IsOutputFormatSupported(output string) bool

IsOutputFormatSupported returns true if the output format is supported

func SupportedOutputFormats

func SupportedOutputFormats() []string

SupportedOutputFormats returns the supported output formats