Update the help descriptions for commands

cmd/atlantis.go

@@ -7,7 +7,7 @@ import (
 // atlantisCmd executes Atlantis commands
 var atlantisCmd = &cobra.Command{
 	Use:                "atlantis",
-	Short:              "Execute 'atlantis' commands",
+	Short:              "Generate and manage Atlantis configurations",
 	Long:               `This command executes Atlantis integration commands`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }

cmd/atlantis_generate.go

@@ -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 configurations for Atlantis automation",
+	Long:               "Generate various configuration files required to integrate and automate Terraform workflows with Atlantis.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

cmd/atlantis_generate_repo_config.go

@@ -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:               "The 'atlantis generate repo-config' command creates the configuration file required for managing repositories with Atlantis.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

cmd/aws.go

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

cmd/aws_eks.go

@@ -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: `This command allows you to execute various 'aws eks' CLI commands for managing Amazon EKS clusters.
+
+	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},
 }
 

cmd/aws_eks_update_kubeconfig.go

@@ -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, 

cmd/completion.go

@@ -11,7 +11,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"},

cmd/describe.go

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

cmd/describe_affected.go

@@ -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:               "This command identifies and lists the Atmos components and stacks that are affected by changes between two Git commits.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

cmd/describe_component.go

@@ -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:               `The 'describe component' command displays the configuration of a specified Atmos component within a designated Atmos stack.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

cmd/describe_config.go

@@ -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)

cmd/describe_dependents.go

@@ -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

cmd/describe_stacks.go

@@ -11,8 +11,8 @@ import (
 // describeStacksCmd describes configuration for stacks and components in the stacks
 var describeStacksCmd = &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

cmd/describe_workflows.go

@@ -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: "Display information about Atmos workflows",
+	Long:  "This command provides details about the Atmos workflows, helping you review and understand the workflows configured in the system.",
 	Example: "describe workflows\n" +
 		"describe workflows --format json\n" +
 		"describe workflows -f yaml\n" +

cmd/docs.go

@@ -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),

cmd/helmfile.go

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

cmd/helmfile_generate.go

@@ -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},
 }
 

cmd/helmfile_generate_varfile.go

@@ -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 varfile for an Atmos Helmfile component",
+	Long:               "This command generates a varfile for a specified Atmos Helmfile component.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration

cmd/list.go

@@ -6,9 +6,10 @@ import (
 
 // listCmd commands list stacks and components
 var listCmd = &cobra.Command{
-	Use:                "list",
-	Short:              "Execute 'list' commands",
-	Long:               `This command lists stacks and components`,
+	Use:   "list",
+	Short: "List available stacks and components",
+	Long: `The 'list' command retrieves and displays a list of all stacks and components within the environment.
+	It provides an overview of the current resources, making it easier to manage and navigate your infrastructure.`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }
 

cmd/list_components.go

@@ -15,8 +15,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:  "This command lists all Atmos components, with the option to filter by specific stacks.",
 	Example: "atmos list components\n" +
 		"atmos list components -s <stack>",
 	Run: func(cmd *cobra.Command, args []string) {

cmd/list_stacks.go

@@ -15,8 +15,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},

cmd/pro.go

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

cmd/terraform.go

@@ -16,7 +16,7 @@ import (
 var terraformCmd = &cobra.Command{
 	Use:                "terraform",
 	Aliases:            []string{"tf"},
-	Short:              "Execute Terraform commands",
+	Short:              "Execute Terraform commands (e.g., plan, apply, destroy) using Atmos stack configurations",
 	Long:               `This command executes Terraform commands`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: true},
 	Run: func(cmd *cobra.Command, args []string) {

cmd/terraform_generate.go

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

cmd/terraform_generate_backend.go

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

cmd/terraform_generate_backends.go

@@ -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

cmd/terraform_generate_varfile.go

@@ -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

cmd/terraform_generate_varfiles.go

@@ -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

cmd/validate.go

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

cmd/validate_component.go

@@ -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 either 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",

cmd/validate_stacks.go

@@ -12,8 +12,8 @@ import (
 // ValidateStacksCmd validates stacks
 var ValidateStacksCmd = &cobra.Command{
 	Use:                "stacks",
-	Short:              "Execute 'validate stacks' command",
-	Long:               `This command validates stack manifest configurations: atmos validate stacks`,
+	Short:              "Validate stack manifest configurations",
+	Long:               "This command validates the configuration of stack manifests in Atmos to ensure proper setup and compliance.",
 	Example:            "validate stacks",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {

cmd/vendor.go

@@ -7,7 +7,7 @@ import (
 // vendorCmd executes 'atmos vendor' CLI commands
 var vendorCmd = &cobra.Command{
 	Use:                "vendor",
-	Short:              "Execute 'vendor' commands",
+	Short:              "Manage external dependencies for components or stacks",
 	Long:               `This command executes 'atmos vendor' CLI commands`,
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 }

cmd/vendor_diff.go

@@ -11,8 +11,8 @@ import (
 // vendorDiffCmd executes 'vendor diff' CLI commands
 var vendorDiffCmd = &cobra.Command{
 	Use:                "diff",
-	Short:              "Execute 'vendor diff' commands",
-	Long:               `This command executes 'atmos vendor diff' CLI commands`,
+	Short:              "Show differences in vendor configurations or dependencies",
+	Long:               "This command compares and displays the differences in vendor-specific configurations or dependencies.",
 	FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check Atmos configuration