root

Documentation

Index

• Constants
• Variables
• func ErrConnectingToServer(err error) error
• func ErrGettingRequestContext(err error) error
• func ErrProcessingConfig(err error) error
• func ErrUnmarshallingAPIData(err error) error
• func Execute() error
• func TreePath() *cobra.Command

Constants

const (
	ErrProcessingConfigCode        = "1088"
	ErrCreatingConfigFileCode      = "1089"
	ErrAddingTokenToConfigCode     = "1090"
	ErrAddingContextToConfigCode   = "1091"
	ErrUnmarshallingConfigFileCode = "1092"
	ErrGettingRequestContextCode   = "1093"
	ErrUnmarshallingAPIDataCode    = "1094"
	ErrConnectingToServerCode      = "1095"
)

Please reference the following before contributing an error code: https://docs.meshery.io/project/contributing/contributing-error https://github.com/meshery/meshkit/blob/master/errors/errors.go

Variables

var (
	ErrCreatingConfigFile = errors.New(ErrCreatingConfigFileCode, errors.Alert, []string{"Unable to create config file"}, []string{"Unable to create config file"}, []string{}, []string{})

	ErrAddingTokenToConfig = errors.New(ErrAddingTokenToConfigCode, errors.Alert, []string{"Unable to add token to config"}, []string{"Unable to add token to config"}, []string{}, []string{})

	ErrAddingContextToConfig = errors.New(ErrAddingContextToConfigCode, errors.Alert, []string{"Unable to add context to config"}, []string{"Unable to add context to config"}, []string{}, []string{})

	ErrUnmarshallingConfigFile = errors.New(ErrUnmarshallingConfigFileCode, errors.Alert, []string{"Error processing json in config file"}, []string{"Error processing json in config file"}, []string{}, []string{})
)

var RootCmd = &cobra.Command{
	Use:   "mesheryctl",
	Short: "Meshery Command Line tool",
	Long: `As a self-service engineering platform, Meshery enables collaborative design and operation of cloud native infrastructure.
Find more information at: https://docs.meshery.io/reference/mesheryctl#command-reference`,
	Example: `
// Base command:
mesheryctl

// Display help about command/subcommand:
mesheryctl --help
mesheryctl system start --help

// For viewing verbose output:
mesheryctl -v [or] --verbose
`,
	RunE: func(cmd *cobra.Command, args []string) error {
		if len(args) == 0 {
			return cmd.Help()
		}

		if ok := utils.IsValidSubcommand(availableSubcommands, args[0]); !ok {
			return errors.New(utils.RootError(fmt.Sprintf("'%s' is an invalid command. Use 'mesheryctl --help' to display usage guide.\n", args[0])))
		}

		return nil
	},
}

RootCmd represents the base command when called without any subcommands

Functions

func ErrConnectingToServer

func ErrConnectingToServer(err error) error

func ErrGettingRequestContext

func ErrGettingRequestContext(err error) error

func ErrProcessingConfig

func ErrProcessingConfig(err error) error

func ErrUnmarshallingAPIData

func ErrUnmarshallingAPIData(err error) error

func Execute

func Execute() error

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the RootCmd.

func TreePath

func TreePath() *cobra.Command