cmd

Documentation

Index

• Variables
• func CheckForAtmosUpdateAndPrintMessage(atmosConfig schema.AtmosConfiguration)
• func Execute() error
• type AtmosValidateOption
  • func WithStackValidation(check bool) AtmosValidateOption
• type ValidateConfig

Variables

var RootCmd = &cobra.Command{
	Use:   "atmos",
	Short: "Universal Tool for DevOps and Cloud Automation",
	Long:  `Atmos is a universal tool for DevOps and cloud automation used for provisioning, managing and orchestrating workflows across various toolchains`,
	PersistentPreRun: func(cmd *cobra.Command, args []string) {

		isHelpCommand := cmd.Name() == "help"
		helpFlag := cmd.Flags().Changed("help")

		isHelpRequested := isHelpCommand || helpFlag

		if isHelpRequested {

			cmd.SilenceUsage = false
			cmd.SilenceErrors = false
		} else {
			cmd.SilenceUsage = true
			cmd.SilenceErrors = true
		}
	},
	Run: func(cmd *cobra.Command, args []string) {

		checkAtmosConfig()

		fmt.Println()
		err := tuiUtils.PrintStyledText("ATMOS")
		if err != nil {
			u.LogErrorAndExit(schema.AtmosConfiguration{}, err)
		}

		err = e.ExecuteAtmosCmd()
		if err != nil {
			u.LogErrorAndExit(schema.AtmosConfiguration{}, err)
		}
	},
}

RootCmd represents the base command when called without any subcommands

var ValidateStacksCmd = &cobra.Command{
	Use:                "stacks",
	Short:              "Execute 'validate stacks' command",
	Long:               `This command validates stack manifest configurations: atmos validate stacks`,
	Example:            "validate stacks",
	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
	Run: func(cmd *cobra.Command, args []string) {

		checkAtmosConfig()

		err := e.ExecuteValidateStacksCmd(cmd, args)
		if err != nil {
			u.LogErrorAndExit(schema.AtmosConfiguration{}, err)
		}

		u.PrintMessageInColor("all stacks validated successfully\n", color.New(color.FgGreen))
	},
}

ValidateStacksCmd validates stacks

Functions

func CheckForAtmosUpdateAndPrintMessage

func CheckForAtmosUpdateAndPrintMessage(atmosConfig schema.AtmosConfiguration)

CheckForAtmosUpdateAndPrintMessage checks if a version update is needed and prints a message if a newer version is found. It loads the cache, decides if it's time to check for updates, compares the current version to the latest available release, and if newer, prints the update message. It also updates the cache's timestamp after printing.

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.

Types

type AtmosValidateOption

type AtmosValidateOption func(*ValidateConfig)

func WithStackValidation

func WithStackValidation(check bool) AtmosValidateOption

type ValidateConfig

type ValidateConfig struct {
	CheckStack bool
}

ValidateConfig holds configuration options for Atmos validation. CheckStack determines whether stack configuration validation should be performed.