cloudposse · aknysh · Jan 8, 2025 · Dec 11, 2024 · Dec 11, 2024 · Dec 12, 2024
@@ -7,8 +7,8 @@ import (
 // atlantisCmd executes Atlantis commands
 var atlantisCmd = &cobra.Command{
 	Use:                "atlantis",
-	Short:              "Execute 'atlantis' commands",
-	Long:               `This command executes Atlantis integration commands`,
+	Short:              "Generate and manage Atlantis configurations",
+	Long:               `Generate and manage Atlantis configurations that use Atmos under the hood to run Terraform workflows, bringing the power of Atmos to Atlantis for streamlined infrastructure automation.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

@@ -7,8 +7,8 @@ import (
 // atlantisGenerateCmd generates various Atlantis configurations
 var atlantisGenerateCmd = &cobra.Command{
 	Use:                "generate",
-	Short:              "Execute 'atlantis generate' commands",
-	Long:               "This command generates various Atlantis configurations",
+	Short:              "Generate Atlantis configuration files",
+	Long:               "This command generates configuration files to automate and streamline Terraform workflows with Atlantis.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

@@ -11,8 +11,8 @@ import (
 // atlantisGenerateRepoConfigCmd generates repository configuration for Atlantis
 var atlantisGenerateRepoConfigCmd = &cobra.Command{
 	Use:                "repo-config",
-	Short:              "Execute 'atlantis generate repo-config`",
-	Long:               "This command generates repository configuration for Atlantis",
+	Short:              "Generate repository configuration for Atlantis",
+	Long:               "Generate the repository configuration file required for Atlantis to manage Terraform repositories.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -7,8 +7,8 @@ import (
 // awsCmd executes 'aws' CLI commands
 var awsCmd = &cobra.Command{
 	Use:                "aws",
-	Short:              "Execute 'aws' commands",
-	Long:               `This command executes 'aws' CLI commands`,
+	Short:              "Run AWS-specific commands for interacting with cloud resources",
+	Long:               `This command allows interaction with AWS resources through various CLI commands.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags:
1E79
 false},
 }
 

@@ -6,9 +6,14 @@ import (
 
 // awsCmd executes 'aws eks' CLI commands
 var awsEksCmd = &cobra.Command{
-	Use:                "eks",
-	Short:              "Execute 'aws eks' commands",
-	Long:               `This command executes 'aws eks' CLI commands`,
+	Use:   "eks",
+	Short: "Run AWS EKS CLI commands for cluster management",
+	Long: `Manage Amazon EKS clusters using AWS CLI, including configuring kubeconfig and performing cluster-related operations.
+
+You can use this command to interact with AWS EKS, including operations like configuring kubeconfig, managing clusters, and more.
+
+For a list of available AWS EKS commands, refer to the Atmos documentation:
+https://atmos.tools/cli/commands/aws/eks-update-kubeconfig`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

@@ -11,8 +11,7 @@ import (
 // awsEksCmdUpdateKubeconfigCmd executes 'aws eks update-kubeconfig' command
 var awsEksCmdUpdateKubeconfigCmd = &cobra.Command{
 	Use:   "update-kubeconfig",
-	Short: "Execute 'aws eks update-kubeconfig' command",
-
+	Short: "Update 'kubeconfig' for an EKS cluster using AWS CLI",
 	Long: `This command executes 'aws eks update-kubeconfig' to download 'kubeconfig' from an EKS cluster and saves it to a file. The command executes 'aws eks update-kubeconfig' in three different ways:
 
 1. If all the required parameters (cluster name and AWS profile/role) are provided on the command-line,

@@ -12,7 +12,7 @@ import (
 
 var completionCmd = &cobra.Command{
 	Use:                   "completion [bash|zsh|fish|powershell]",
-	Short:                 "Generate completion script for Bash, Zsh, Fish and PowerShell",
+	Short:                 "Generate autocompletion scripts for Bash, Zsh, Fish, and PowerShell",
 	Long:                  "This command generates completion scripts for Bash, Zsh, Fish and PowerShell",
 	DisableFlagsInUseLine: true,
 	ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},

@@ -7,8 +7,8 @@ import (
 // describeCmd describes configuration for stacks and components
 var describeCmd = &cobra.Command{
 	Use:                "describe",
-	Short:              "Execute 'describe' commands",
-	Long:               `This command shows configuration for CLI, stacks and components`,
+	Short:              "Show details about Atmos configurations and components",
+	Long:               `Display configuration details for Atmos CLI, stacks, and components.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

@@ -11,8 +11,8 @@ import (
 // describeAffectedCmd produces a list of the affected Atmos components and stacks given two Git commits
 var describeAffectedCmd = &cobra.Command{
 	Use:                "affected",
-	Short:              "Execute 'describe affected' command",
-	Long:               `This command produces a list of the affected Atmos components and stacks given two Git commits: atmos describe affected [options]`,
+	Short:              "List Atmos components and stacks affected by two Git commits",
+	Long:               "Identify and list Atmos components and stacks impacted by changes between two Git commits.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -11,8 +11,8 @@ import (
 // describeComponentCmd describes configuration for components
 var describeComponentCmd = &cobra.Command{
 	Use:                "component",
-	Short:              "Execute 'describe component' command",
-	Long:               `This command shows configuration for an Atmos component in an Atmos stack: atmos describe component <component> -s <stack>`,
+	Short:              "Show configuration details for an Atmos component in a stack",
+	Long:               `Display the configuration details for a specific Atmos component within a designated Atmos stack, including its dependencies, settings, and overrides.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -11,8 +11,8 @@ import (
 // describeComponentCmd describes configuration for components
 var describeConfigCmd = &cobra.Command{
 	Use:                "config",
-	Short:              "Execute 'describe config' command",
-	Long:               `This command shows the final (deep-merged) CLI configuration: atmos describe config`,
+	Short:              "Display the final merged CLI configuration",
+	Long:               "This command displays the final, deep-merged CLI configuration after combining all relevant configuration files.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		err := e.ExecuteDescribeConfigCmd(cmd, args)

@@ -12,8 +12,8 @@ import (
 var describeDependentsCmd = &cobra.Command{
 	Use:                "dependents",
 	Aliases:            []string{"dependants"},
-	Short:              "Execute 'describe dependents' command",
-	Long:               `This command produces a list of Atmos components in Atmos stacks that depend on the provided Atmos component: atmos describe dependents [options]`,
+	Short:              "List Atmos components that depend on a given component",
+	Long:               "This command generates a list of Atmos components within stacks that depend on the specified Atmos component.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -11,8 +11,8 @@ import (
 // describeStacksCmd describes configuration for stacks and components in the stacks
 var describeStacksCmd =
B93C
 &cobra.Command{
 	Use:                "stacks",
-	Short:              "Execute 'describe stacks' command",
-	Long:               `This command shows configuration for atmos stacks and components in the stacks: atmos describe stacks [options]`,
+	Short:              "Display configuration for Atmos stacks and their components",
+	Long:               "This command shows the configuration details for Atmos stacks and the components within those stacks.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -11,8 +11,8 @@ import (
 // describeWorkflowsCmd executes 'atmos describe workflows' CLI commands
 var describeWorkflowsCmd = &cobra.Command{
 	Use:   "workflows",
-	Short: "Execute 'describe workflows' commands",
-	Long:  `This command executes 'atmos describe workflows' CLI command`,
+	Short: "List Atmos workflows and their associated files",
+	Long:  "List all Atmos workflows, showing their associated files and workflow names for easy reference.",
 	Example: "describe workflows\n" +
 		"describe workflows --format json\n" +
 		"describe workflows -f yaml\n" +

@@ -22,7 +22,7 @@ const atmosDocsURL = "https://atmos.tools"
 // docsCmd opens the Atmos docs and can display component documentation
 var docsCmd = &cobra.Command{
 	Use:                "docs",
-	Short:              "Open the Atmos docs or display component documentation",
+	Short:              "Open Atmos documentation or display component-specific docs",
 	Long:               `This command opens the Atmos docs or displays the documentation for a specified Atmos component.`,
 	Example:            "atmos docs vpc",
 	Args:               cobra.MaximumNArgs(1),

@@ -13,8 +13,8 @@ import (
 var helmfileCmd = &cobra.Command{
 	Use:                "helmfile",
 	Aliases:            []string{"hf"},
-	Short:              "Execute 'helmfile' commands",
-	Long:               `This command runs Helmfile commands`,
+	Short:              "Manage Helmfile-based Kubernetes deployments",
+	Long:               `This command runs Helmfile commands to manage Kubernetes deployments using Helmfile.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: true},
 	Run: func(cmd *cobra.Command, args []string) {
 

@@ -7,8 +7,8 @@ import (
 // helmfileGenerateCmd generates configurations for helmfile components
 var helmfileGenerateCmd = &cobra.Command{
 	Use:                "generate",
-	Short:              "Execute 'helmfile generate' commands",
-	Long:               "This command generates configurations for helmfile components",
+	Short:              "Generate configurations for Helmfile components",
+	Long:               "This command generates various configuration files for Helmfile components in Atmos.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

@@ -11,8 +11,8 @@ import (
 // helmfileGenerateVarfileCmd generates varfile for a helmfile component
 var helmfileGenerateVarfileCmd = &cobra.Command{
 	Use:                "varfile",
-	Short:              "Execute 'helmfile generate varfile' command",
-	Long:               `This command generates a varfile for an atmos helmfile component: atmos helmfile generate varfile <component> -s <stack> -f <file>`,
+	Short:              "Generate a values file for a Helmfile component",
+	Long:               "This command generates a values file for a specified Helmfile component.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -7,8 +7,8 @@ import (
 // listCmd commands list stacks and components
 var listCmd = &cobra.Command{
 	Use:                "list",
-	Short:              "Execute 'list' commands",
-	Long:               `This command lists stacks and components`,
+	Short:              "List available stacks and components",
+	Long:               `Display a list of all available stacks and components defined in your project.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

@@ -16,8 +16,8 @@ import (
 // listComponentsCmd lists atmos components
 var listComponentsCmd = &cobra.Command{
 	Use:   "components",
-	Short: "Execute 'list components' command",
-	Long:  `This command lists all Atmos components or filters components by stacks.`,
 	Short: "List all Atmos components or filter by stack",
+	Long:  "List Atmos components, with options to filter results by specific stacks.",
 	Example: "atmos list components\n" +
 		"atmos list components -s <stack>",
 	Run: func(cmd *cobra.Command, args []string) {

@@ -16,8 +16,8 @@ import (
 // listStacksCmd lists atmos stacks
 var listStacksCmd = &cobra.Command{
 	Use:   "stacks",
-	Short: "Execute 'list stacks' command",
-	Long:  `This command lists all Atmos stacks or all stacks for the specified component: atmos list stacks -c <component>`,
+	Short: "List all Atmos stacks or stacks for a specific component",
+	Long:  "This command lists all Atmos stacks, or filters the list to show only the stacks associated with a specified component.",
 	Example: "atmos list stacks\n" +
 		"atmos list stacks -c <component>",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},

@@ -7,8 +7,8 @@ import (
 // proCmd executes 'atmos pro' CLI commands
 var proCmd = &cobra.Command{
 	Use:                "pro",
-	Short:              "Execute 'pro' commands",
-	Long:               `This command executes 'atmos pro' CLI commands`,
+	Short:              "Access premium features integrated with app.cloudposse.com",
+	Long:               `This command allows you to manage and configure premium features available through app.cloudposse.com.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

@@ -25,8 +25,8 @@ const atmosInfoKey contextKey = "atmos_info"
 var terraformCmd = &cobra.Command{
 	Use:                "terraform",
 	Aliases:            []string{"tf"},
-	Short:              "Execute Terraform commands",
-	Long:               `This command executes Terraform commands`,
+	Short:              "Execute Terraform commands (e.g., plan, apply, destroy) using Atmos stack configurations",
+	Long:               `This command allows you to execute Terraform commands, such as plan, apply, and destroy, using Atmos stack configurations for consistent infrastructure management.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: true},
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return terraformRun(cmd, cmd, args)
@@ -170,10 +170,13 @@ func terraformRun(cmd *cobra.Command, actualCmd *cobra.Command, args []string) e
 				ExecName: cc.Bold,
 				Flags:    cc.Bold,
 			})
+		}
 
+		err := actualCmd.Help()
+		if err != nil {
+			return err
 		}
 
-		actualCmd.Help()
 		return nil
 	}
 	// Check Atmos configuration

@@ -16,7 +16,6 @@ This command supports the following subcommands:
 - 'backends' to generate backend configuration files for all Atmos components in all stacks.
 - 'varfile' to generate a variable file (varfile) for an Atmos component in a stack.
 - 'varfiles' to generate varfiles for all Atmos components in all stacks.`,
-
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return terraformRun(cmd, cmd, args)

@@ -11,8 +11,9 @@ import (
 // terraformGenerateBackendCmd generates backend config for a terraform component
 var terraformGenerateBackendCmd = &cobra.Command{
 	Use:                "backend",
-	Short:              "Execute 'terraform generate backend' command",
-	Long:               `This command generates the backend config for a terraform component: atmos terraform generate backend <component> -s <stack>`,
+	Short:              "Generate backend configuration for a Terraform component",
+	Long:               `This command generates the backend configuration for a Terraform component using the specified stack`,
+	Example:            `atmos terraform generate backend <component> -s <stack>`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -11,8 +11,8 @@ import (
 // terraformGenerateBackendsCmd generates backend configs for all terraform components
 var terraformGenerateBackendsCmd = &cobra.Command{
 	Use:                "backends",
-	Short:              "Execute 'terraform generate backends' command",
-	Long:               `This command generates backend configs for all terraform components`,
+	Short:              "Generate backend configurations for all Terraform components",
+	Long:               "This command generates the backend configuration files for all Terraform components in the Atmos environment.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -11,8 +11,8 @@ import (
 // terraformGenerateVarfileCmd generates varfile for a terraform component
 var terraformGenerateVarfileCmd = &cobra.Command{
 	Use:                "varfile",
-	Short:              "Execute 'terraform generate varfile' command",
-	Long:               `This command generates a varfile for an atmos terraform component: atmos terraform generate varfile <component> -s <stack> -f <file>`,
 	Short:              "Generate a varfile for a Terraform component",
+	Long:               "This command generates a `varfile` for a specified Atmos Terraform component.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -11,8 +11,8 @@ import (
 // terraformGenerateVarfilesCmd generates varfiles for all terraform components in all stacks
 var terraformGenerateVarfilesCmd = &cobra.Command{
 	Use:                "varfiles",
-	Short:              "Execute 'terraform generate varfiles' command",
-	Long:               `This command generates varfiles for all atmos terraform components in all stacks`,
+	Short:              "Generate varfiles for all Terraform components in all stacks",
+	Long:               "This command generates varfiles for all Atmos Terraform components across all stacks.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

@@ -7,8 +7,8 @@ import (
 // validateCmd commands validate stacks and components
 var validateCmd = &cobra.Command{
 	Use:                "validate",
-	Short:              "Execute 'validate' commands",
-	Long:               `This command validates stacks and components`,
+	Short:              "Validate configurations against OPA policies and JSON schemas",
+	Long:               `This command validates stacks and components by checking their configurations against Open Policy Agent (OPA) policies and JSON schemas.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

@@ -14,8 +14,8 @@ import (
 // validateComponentCmd validates atmos components
 var validateComponentCmd = &cobra.Command{
 	Use:   "component",
-	Short: "Execute 'validate component' command",
-	Long:  `This command validates an atmos component in a stack using Json Schema or OPA policies: atmos validate component <component> -s <stack> --schema-path <schema_path> --schema-type <jsonschema|opa>`,
+	Short: "Validate an Atmos component in a stack using JSON Schema or OPA policies",
+	Long:  "This command validates an Atmos component within a stack using JSON Schema or OPA policies.",
 	Example: "atmos validate component <component> -s <stack>\n" +
 		"atmos validate component <component> -s <stack> --schema-path <schema_path> --schema-type <jsonschema|opa>\n" +
 		"atmos validate component <component> -s <stack> --schema-path <schema_path> --schema-type opa --module-paths catalog",