cmd

Documentation

Overview

Package cmd provides the Constellation CLI.

It is responsible for the interaction with the user.

Logic should be kept to input/output parsing whenever possible. Any more complex code should usually be implemented in one of the other CLI packages.

The code here should be kept as cloud provider agnostic as possible. Any CSP specific tasks should be handled by the "cloudcmd" package.

All filepaths handled by the CLI code should originate from here. Common filepaths are defined as constants in the global "/internal/constants" package. To generate workspace correct filepaths for printing, use the functions from the "workspace" package.

Index

• Variables
• func NewApplyCmd() *cobra.Command
• func NewConfigCmd() *cobra.Command
• func NewCreateCmd() *cobra.Command
• func NewIAMCmd() *cobra.Command
• func NewInitCmd() *cobra.Command
• func NewMaaPatchCmd() *cobra.Command
• func NewMiniCmd() *cobra.Command
• func NewRecoverCmd() *cobra.Command
• func NewStatusCmd() *cobra.Command
• func NewTerminateCmd() *cobra.Command
• func NewUpgradeCmd() *cobra.Command
• func NewVerifyCmd() *cobra.Command
• func NewVersionCmd() *cobra.Command

Variables

var ErrInvalidInput = errors.New("user made invalid input")

ErrInvalidInput is an error where user entered invalid input.

Functions

func NewApplyCmd

func NewApplyCmd() *cobra.Command

NewApplyCmd creates the apply command.

func NewConfigCmd

func NewConfigCmd() *cobra.Command

NewConfigCmd creates a new config parent command. Config needs another verb, and does nothing on its own.

func NewCreateCmd

func NewCreateCmd() *cobra.Command

NewCreateCmd returns a new cobra.Command for the create command.

func NewIAMCmd

func NewIAMCmd() *cobra.Command

NewIAMCmd returns a new cobra.Command for the iam parent command. It needs another verb and does nothing on its own.

func NewInitCmd

func NewInitCmd() *cobra.Command

NewInitCmd returns a new cobra.Command for the init command.

func NewMaaPatchCmd

func NewMaaPatchCmd() *cobra.Command

NewMaaPatchCmd returns a new cobra.Command for the maa-patch command.

func NewMiniCmd

func NewMiniCmd() *cobra.Command

NewMiniCmd creates a new cobra.Command for managing MiniConstellation clusters.

func NewRecoverCmd

func NewRecoverCmd() *cobra.Command

NewRecoverCmd returns a new cobra.Command for the recover command.

func NewStatusCmd

func NewStatusCmd() *cobra.Command

NewStatusCmd returns a new cobra.Command for the statuus command.

func NewTerminateCmd

func NewTerminateCmd() *cobra.Command

NewTerminateCmd returns a new cobra.Command for the terminate command.

func NewUpgradeCmd

func NewUpgradeCmd() *cobra.Command

NewUpgradeCmd returns a new cobra.Command for the upgrade command.

func NewVerifyCmd

func NewVerifyCmd() *cobra.Command

NewVerifyCmd returns a new cobra.Command for the verify command.

func NewVersionCmd

func NewVersionCmd() *cobra.Command

NewVersionCmd returns a new cobra.Command for the verify command.