From 82c91c36359fab10b70ea7c3d9f4be059b5d0649 Mon Sep 17 00:00:00 2001 From: Sam Tholiya Date: Wed, 11 Dec 2024 19:26:03 +0100 Subject: [PATCH 01/14] Update the help descriptions for commands issue: https://linear.app/cloudposse/issue/DEV-2823/atmos-commands-should-describe-what-they-do parent issue: https://linear.app/cloudposse/issue/DEV-2740/atmos-help-should-show-meaningful-descriptions-of-commands --- cmd/atlantis.go | 2 +- cmd/aws.go | 2 +- cmd/completion.go | 2 +- cmd/describe.go | 2 +- cmd/docs.go | 2 +- cmd/helmfile.go | 2 +- cmd/list.go | 7 ++++--- cmd/pro.go | 2 +- cmd/terraform.go | 2 +- cmd/validate.go | 2 +- cmd/vendor.go | 2 +- cmd/version.go | 2 +- cmd/workflow.go | 2 +- 13 files changed, 16 insertions(+), 15 deletions(-) diff --git a/cmd/atlantis.go b/cmd/atlantis.go index cefefa8b5..fd3a8c585 100644 --- a/cmd/atlantis.go +++ b/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}, } diff --git a/cmd/aws.go b/cmd/aws.go index 4976dee10..a13824ceb 100644 --- a/cmd/aws.go +++ b/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}, } diff --git a/cmd/completion.go b/cmd/completion.go index cde9287df..6f0729739 100644 --- a/cmd/completion.go +++ b/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"}, diff --git a/cmd/describe.go b/cmd/describe.go index 4e134f584..165f64f84 100644 --- a/cmd/describe.go +++ b/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}, } diff --git a/cmd/docs.go b/cmd/docs.go index 547cd018a..c9cad03a2 100644 --- a/cmd/docs.go +++ b/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), diff --git a/cmd/helmfile.go b/cmd/helmfile.go index ae7280fe7..e4fb07c84 100644 --- a/cmd/helmfile.go +++ b/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) { diff --git a/cmd/list.go b/cmd/list.go index 62862c8b2..e1f7282d0 100644 --- a/cmd/list.go +++ b/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}, } diff --git a/cmd/pro.go b/cmd/pro.go index f619604d8..0883f5c7e 100644 --- a/cmd/pro.go +++ b/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}, } diff --git a/cmd/terraform.go b/cmd/terraform.go index 3b5ec3783..5d8832c1b 100644 --- a/cmd/terraform.go +++ b/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) { diff --git a/cmd/validate.go b/cmd/validate.go index c5a3abda1..2d59aef52 100644 --- a/cmd/validate.go +++ b/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}, } diff --git a/cmd/vendor.go b/cmd/vendor.go index 096a17330..18af21c9b 100644 --- a/cmd/vendor.go +++ b/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}, } diff --git a/cmd/version.go b/cmd/version.go index 5146f4ff3..3665077c6 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -15,7 +15,7 @@ import ( var versionCmd = &cobra.Command{ Use: "version", - Short: "Print the CLI version", + Short: "Show the installed Atmos CLI version and check for updates", Long: `This command prints the CLI version`, Example: "atmos version", Run: func(cmd *cobra.Command, args []string) { diff --git a/cmd/workflow.go b/cmd/workflow.go index 206382eed..74b78bf1b 100644 --- a/cmd/workflow.go +++ b/cmd/workflow.go @@ -11,7 +11,7 @@ import ( // workflowCmd executes a workflow var workflowCmd = &cobra.Command{ Use: "workflow", - Short: "Execute a workflow", + Short: "Run automated workflows for infrastructure and operations", Long: `This command executes a workflow: atmos workflow -f `, Example: "atmos workflow\n" + "atmos workflow -f \n" + From 29e309e73dc9438dc6b4f4ebfdd31cf862d0cef7 Mon Sep 17 00:00:00 2001 From: Sam Tholiya Date: Wed, 11 Dec 2024 19:26:03 +0100 Subject: [PATCH 02/14] Update the help descriptions for commands issue: https://linear.app/cloudposse/issue/DEV-2823/atmos-commands-should-describe-what-they-do parent issue: https://linear.app/cloudposse/issue/DEV-2740/atmos-help-should-show-meaningful-descriptions-of-commands --- cmd/atlantis.go | 2 +- cmd/atlantis_generate.go | 4 ++-- cmd/atlantis_generate_repo_config.go | 4 ++-- cmd/aws.go | 2 +- cmd/aws_eks.go | 11 ++++++++--- cmd/aws_eks_update_kubeconfig.go | 3 +-- cmd/completion.go | 2 +- cmd/describe.go | 2 +- cmd/describe_affected.go | 4 ++-- cmd/describe_component.go | 4 ++-- cmd/describe_config.go | 4 ++-- cmd/describe_dependents.go | 4 ++-- cmd/describe_stacks.go | 4 ++-- cmd/describe_workflows.go | 4 ++-- cmd/docs.go | 2 +- cmd/helmfile.go | 2 +- cmd/helmfile_generate.go | 4 ++-- cmd/helmfile_generate_varfile.go | 4 ++-- cmd/list.go | 7 ++++--- cmd/list_components.go | 4 ++-- cmd/list_stacks.go | 4 ++-- cmd/pro.go | 2 +- cmd/terraform.go | 2 +- cmd/terraform_generate.go | 4 ++-- cmd/terraform_generate_backend.go | 2 +- cmd/terraform_generate_backends.go | 4 ++-- cmd/terraform_generate_varfile.go | 4 ++-- cmd/terraform_generate_varfiles.go | 4 ++-- cmd/validate.go | 2 +- cmd/validate_component.go | 4 ++-- cmd/validate_stacks.go | 4 ++-- cmd/vendor.go | 2 +- cmd/vendor_diff.go | 4 ++-- cmd/vendor_pull.go | 4 ++-- cmd/version.go | 2 +- cmd/workflow.go | 2 +- internal/tui/templates/templater.go | 9 +++++++++ 37 files changed, 75 insertions(+), 61 deletions(-) diff --git a/cmd/atlantis.go b/cmd/atlantis.go index cefefa8b5..fd3a8c585 100644 --- a/cmd/atlantis.go +++ b/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}, } diff --git a/cmd/atlantis_generate.go b/cmd/atlantis_generate.go index 97688d568..c4133300d 100644 --- a/cmd/atlantis_generate.go +++ b/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}, } diff --git a/cmd/atlantis_generate_repo_config.go b/cmd/atlantis_generate_repo_config.go index 5bcf00b2d..d4e084c8b 100644 --- a/cmd/atlantis_generate_repo_config.go +++ b/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 diff --git a/cmd/aws.go b/cmd/aws.go index 4976dee10..a13824ceb 100644 --- a/cmd/aws.go +++ b/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}, } diff --git a/cmd/aws_eks.go b/cmd/aws_eks.go index 9b80f7262..4bdbc617e 100644 --- a/cmd/aws_eks.go +++ b/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 AWS CLI documentation: + https://docs.aws.amazon.com/cli/latest/reference/eks/`, FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, } diff --git a/cmd/aws_eks_update_kubeconfig.go b/cmd/aws_eks_update_kubeconfig.go index 51d0312cf..69ac366dd 100644 --- a/cmd/aws_eks_update_kubeconfig.go +++ b/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, diff --git a/cmd/completion.go b/cmd/completion.go index cde9287df..6f0729739 100644 --- a/cmd/completion.go +++ b/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"}, diff --git a/cmd/describe.go b/cmd/describe.go index 4e134f584..165f64f84 100644 --- a/cmd/describe.go +++ b/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}, } diff --git a/cmd/describe_affected.go b/cmd/describe_affected.go index 815aa1801..51b2ef87f 100644 --- a/cmd/describe_affected.go +++ b/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 diff --git a/cmd/describe_component.go b/cmd/describe_component.go index 4ae3cc9fe..81cef349f 100644 --- a/cmd/describe_component.go +++ b/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 -s `, + 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 diff --git a/cmd/describe_config.go b/cmd/describe_config.go index 87fead79a..aed9b547b 100644 --- a/cmd/describe_config.go +++ b/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) diff --git a/cmd/describe_dependents.go b/cmd/describe_dependents.go index 94e384c4c..49f7309e6 100644 --- a/cmd/describe_dependents.go +++ b/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 diff --git a/cmd/describe_stacks.go b/cmd/describe_stacks.go index 8b6d87fb1..7c3feb07e 100644 --- a/cmd/describe_stacks.go +++ b/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 diff --git a/cmd/describe_workflows.go b/cmd/describe_workflows.go index 4e8e1020b..a3a30900a 100644 --- a/cmd/describe_workflows.go +++ b/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" + diff --git a/cmd/docs.go b/cmd/docs.go index 547cd018a..c9cad03a2 100644 --- a/cmd/docs.go +++ b/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), diff --git a/cmd/helmfile.go b/cmd/helmfile.go index ae7280fe7..e4fb07c84 100644 --- a/cmd/helmfile.go +++ b/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) { diff --git a/cmd/helmfile_generate.go b/cmd/helmfile_generate.go index 39532c7ae..781f92bb1 100644 --- a/cmd/helmfile_generate.go +++ b/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}, } diff --git a/cmd/helmfile_generate_varfile.go b/cmd/helmfile_generate_varfile.go index 57f8a66d5..b318c937f 100644 --- a/cmd/helmfile_generate_varfile.go +++ b/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 -s -f `, + 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 diff --git a/cmd/list.go b/cmd/list.go index 62862c8b2..e1f7282d0 100644 --- a/cmd/list.go +++ b/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}, } diff --git a/cmd/list_components.go b/cmd/list_components.go index 03cf6feff..f3c90b854 100644 --- a/cmd/list_components.go +++ b/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 ", Run: func(cmd *cobra.Command, args []string) { diff --git a/cmd/list_stacks.go b/cmd/list_stacks.go index 38d5e547e..3a83afdae 100644 --- a/cmd/list_stacks.go +++ b/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 `, + 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 ", FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, diff --git a/cmd/pro.go b/cmd/pro.go index f619604d8..0883f5c7e 100644 --- a/cmd/pro.go +++ b/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}, } diff --git a/cmd/terraform.go b/cmd/terraform.go index 3b5ec3783..5d8832c1b 100644 --- a/cmd/terraform.go +++ b/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) { diff --git a/cmd/terraform_generate.go b/cmd/terraform_generate.go index 1c51e9acf..4032af91f 100644 --- a/cmd/terraform_generate.go +++ b/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}, } diff --git a/cmd/terraform_generate_backend.go b/cmd/terraform_generate_backend.go index 4912aee2c..0ef297222 100644 --- a/cmd/terraform_generate_backend.go +++ b/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 -s `, FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, Run: func(cmd *cobra.Command, args []string) { diff --git a/cmd/terraform_generate_backends.go b/cmd/terraform_generate_backends.go index 3c80fedb2..70a6c989d 100644 --- a/cmd/terraform_generate_backends.go +++ b/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 diff --git a/cmd/terraform_generate_varfile.go b/cmd/terraform_generate_varfile.go index c82ac14b8..5de0b005e 100644 --- a/cmd/terraform_generate_varfile.go +++ b/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 -s -f `, + 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 diff --git a/cmd/terraform_generate_varfiles.go b/cmd/terraform_generate_varfiles.go index 1031fbb2f..d37c72f1b 100644 --- a/cmd/terraform_generate_varfiles.go +++ b/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 diff --git a/cmd/validate.go b/cmd/validate.go index c5a3abda1..2d59aef52 100644 --- a/cmd/validate.go +++ b/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}, } diff --git a/cmd/validate_component.go b/cmd/validate_component.go index 9b2980cbd..f93176fe2 100644 --- a/cmd/validate_component.go +++ b/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 -s --schema-path --schema-type `, + 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 -s \n" + "atmos validate component -s --schema-path --schema-type \n" + "atmos validate component -s --schema-path --schema-type opa --module-paths catalog", diff --git a/cmd/validate_stacks.go b/cmd/validate_stacks.go index d38ff01ad..daeac0893 100644 --- a/cmd/validate_stacks.go +++ b/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) { diff --git a/cmd/vendor.go b/cmd/vendor.go index 096a17330..18af21c9b 100644 --- a/cmd/vendor.go +++ b/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}, } diff --git a/cmd/vendor_diff.go b/cmd/vendor_diff.go index 61cad8771..c2f94bca2 100644 --- a/cmd/vendor_diff.go +++ b/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 diff --git a/cmd/vendor_pull.go b/cmd/vendor_pull.go index 50fe6cec1..9ca51edfd 100644 --- a/cmd/vendor_pull.go +++ b/cmd/vendor_pull.go @@ -11,8 +11,8 @@ import ( // vendorPullCmd executes 'vendor pull' CLI commands var vendorPullCmd = &cobra.Command{ Use: "pull", - Short: "Execute 'vendor pull' commands", - Long: `This command executes 'atmos vendor pull' CLI commands`, + Short: "Pull the latest vendor configurations or dependencies", + Long: "Pull and update vendor-specific configurations or dependencies to ensure the project has the latest required resources.", FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, Run: func(cmd *cobra.Command, args []string) { // WithStackValidation is a functional option that enables/disables stack configuration validation diff --git a/cmd/version.go b/cmd/version.go index 5146f4ff3..3665077c6 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -15,7 +15,7 @@ import ( var versionCmd = &cobra.Command{ Use: "version", - Short: "Print the CLI version", + Short: "Show the installed Atmos CLI version and check for updates", Long: `This command prints the CLI version`, Example: "atmos version", Run: func(cmd *cobra.Command, args []string) { diff --git a/cmd/workflow.go b/cmd/workflow.go index 206382eed..74b78bf1b 100644 --- a/cmd/workflow.go +++ b/cmd/workflow.go @@ -11,7 +11,7 @@ import ( // workflowCmd executes a workflow var workflowCmd = &cobra.Command{ Use: "workflow", - Short: "Execute a workflow", + Short: "Run automated workflows for infrastructure and operations", Long: `This command executes a workflow: atmos workflow -f `, Example: "atmos workflow\n" + "atmos workflow -f \n" + diff --git a/internal/tui/templates/templater.go b/internal/tui/templates/templater.go index 9ba5c4525..527238abe 100644 --- a/internal/tui/templates/templater.go +++ b/internal/tui/templates/templater.go @@ -34,6 +34,12 @@ func formatCommand(name string, desc string, padding int) string { return fmt.Sprintf(" %s %s", styledName, styledDesc) } +var customHelpShortMessage = map[string]string{ + "help": "Display help information for Atmos commands", + "tf": "Execute Terraform commands (e.g., plan, apply, destroy) using Atmos stack configurations", + "show": "Display help for show", +} + // formatCommands formats a slice of cobra commands with proper styling func formatCommands(cmds []*cobra.Command) string { var maxLen int @@ -47,6 +53,9 @@ func formatCommands(cmds []*cobra.Command) string { maxLen = len(cmd.Name()) } } + if v, ok := customHelpShortMessage[cmd.Name()]; ok { + cmd.Short = v + } } var lines []string From 0cb5f1a3ab44a79895dfc84fb6389113947f4020 Mon Sep 17 00:00:00 2001 From: Sam Tholiya Date: Fri, 13 Dec 2024 07:52:29 +0100 Subject: [PATCH 03/14] Update help content --- cmd/aws_eks.go | 4 ++-- internal/tui/templates/templater.go | 3 +-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/cmd/aws_eks.go b/cmd/aws_eks.go index 4bdbc617e..3fbc6f8bf 100644 --- a/cmd/aws_eks.go +++ b/cmd/aws_eks.go @@ -12,8 +12,8 @@ var awsEksCmd = &cobra.Command{ 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 AWS CLI documentation: - https://docs.aws.amazon.com/cli/latest/reference/eks/`, + 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}, } diff --git a/internal/tui/templates/templater.go b/internal/tui/templates/templater.go index b48a523bf..a5976f186 100644 --- a/internal/tui/templates/templater.go +++ b/internal/tui/templates/templater.go @@ -36,8 +36,7 @@ func formatCommand(name string, desc string, padding int) string { var customHelpShortMessage = map[string]string{ "help": "Display help information for Atmos commands", - "tf": "Execute Terraform commands (e.g., plan, apply, destroy) using Atmos stack configurations", - "show": "Display help for show", + "tf": "Alias for ‘terraform’ commands", } // formatCommands formats a slice of cobra commands with proper styling From a0ca46712e148e17cd0bc75d98f3c0615f1f1ddd Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:56:19 -0600 Subject: [PATCH 04/14] Update cmd/list_components.go --- cmd/list_components.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/list_components.go b/cmd/list_components.go index f3c90b854..7ff8db127 100644 --- a/cmd/list_components.go +++ b/cmd/list_components.go @@ -16,7 +16,7 @@ import ( var listComponentsCmd = &cobra.Command{ Use: "components", Short: "List all Atmos components or filter by stack", - Long: "This command lists all Atmos components, with the option to filter by specific stacks.", + Long: "List Atmos components, with options to filter results by specific stacks.", Example: "atmos list components\n" + "atmos list components -s ", Run: func(cmd *cobra.Command, args []string) { From 0b8b2326426433734580c04d4af90ce10786ad2f Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:56:30 -0600 Subject: [PATCH 05/14] Update cmd/list.go --- cmd/list.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/cmd/list.go b/cmd/list.go index e1f7282d0..28e3a8516 100644 --- a/cmd/list.go +++ b/cmd/list.go @@ -8,8 +8,7 @@ import ( var listCmd = &cobra.Command{ 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.`, + Long: `Retrieve and display a list of all available stacks and components in your environment.`, FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, } From 1d6041da5b3fc69f0619efc86e16e10c4eb1af22 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:56:40 -0600 Subject: [PATCH 06/14] Update cmd/atlantis_generate.go --- cmd/atlantis_generate.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/atlantis_generate.go b/cmd/atlantis_generate.go index c4133300d..939a4b65d 100644 --- a/cmd/atlantis_generate.go +++ b/cmd/atlantis_generate.go @@ -7,7 +7,7 @@ import ( // atlantisGenerateCmd generates various Atlantis configurations var atlantisGenerateCmd = &cobra.Command{ Use: "generate", - Short: "Generate configurations for Atlantis automation", + Short: "Generate Atlantis configuration files", Long: "Generate various configuration files required to integrate and automate Terraform workflows with Atlantis.", FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, } From ac3e0b48b9e389c7fafed2c9ad9b7193948cbab0 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:56:48 -0600 Subject: [PATCH 07/14] Update cmd/atlantis_generate.go --- cmd/atlantis_generate.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/atlantis_generate.go b/cmd/atlantis_generate.go index 939a4b65d..e5bfa8948 100644 --- a/cmd/atlantis_generate.go +++ b/cmd/atlantis_generate.go @@ -8,7 +8,7 @@ import ( var atlantisGenerateCmd = &cobra.Command{ Use: "generate", Short: "Generate Atlantis configuration files", - Long: "Generate various configuration files required to integrate and automate Terraform workflows with Atlantis.", + Long: "This command generates configuration files to automate and streamline Terraform workflows with Atlantis.", FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, } From da1a8da692fae99f16137a68acbddc1eef844f04 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:56:58 -0600 Subject: [PATCH 08/14] Update cmd/atlantis_generate_repo_config.go --- cmd/atlantis_generate_repo_config.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/atlantis_generate_repo_config.go b/cmd/atlantis_generate_repo_config.go index d4e084c8b..2c04f948d 100644 --- a/cmd/atlantis_generate_repo_config.go +++ b/cmd/atlantis_generate_repo_config.go @@ -12,7 +12,7 @@ import ( var atlantisGenerateRepoConfigCmd = &cobra.Command{ Use: "repo-config", Short: "Generate repository configuration for Atlantis", - Long: "The 'atlantis generate repo-config' command creates the configuration file required for managing repositories with 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 From 4f229221c6d076a81c7f4ade710bbd4697e60309 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:57:05 -0600 Subject: [PATCH 09/14] Update cmd/atlantis.go --- cmd/atlantis.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/atlantis.go b/cmd/atlantis.go index fd3a8c585..08adda36c 100644 --- a/cmd/atlantis.go +++ b/cmd/atlantis.go @@ -8,7 +8,7 @@ import ( var atlantisCmd = &cobra.Command{ Use: "atlantis", Short: "Generate and manage Atlantis configurations", - Long: `This command executes Atlantis integration commands`, + Long: `This command enables integration with Atlantis, allowing users to generate configurations for Terraform workflows.`, FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, } From 96674d0bf6e5ca60b97ef3c28f9268396715c851 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:57:14 -0600 Subject: [PATCH 10/14] Update cmd/describe.go --- cmd/describe.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/describe.go b/cmd/describe.go index 165f64f84..b4942813f 100644 --- a/cmd/describe.go +++ b/cmd/describe.go @@ -8,7 +8,7 @@ import ( var describeCmd = &cobra.Command{ Use: "describe", Short: "Show details about Atmos configurations and components", - Long: `This command shows configuration for CLI, stacks and components`, + Long: `Display configuration details for Atmos CLI, stacks, and components.`, FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, } From f827a8566642f7fc833c4a06dfd25961b70edbe0 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:57:25 -0600 Subject: [PATCH 11/14] Update cmd/describe_affected.go --- cmd/describe_affected.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/describe_affected.go b/cmd/describe_affected.go index 51b2ef87f..efb425d2e 100644 --- a/cmd/describe_affected.go +++ b/cmd/describe_affected.go @@ -12,7 +12,7 @@ import ( var describeAffectedCmd = &cobra.Command{ Use: "affected", 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.", + 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 From 4f32320dd36a8651a8b54d3c1ad3b05f2aa66d31 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:57:37 -0600 Subject: [PATCH 12/14] Update cmd/aws.go --- cmd/aws.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/aws.go b/cmd/aws.go index a13824ceb..35dd505c4 100644 --- a/cmd/aws.go +++ b/cmd/aws.go @@ -8,7 +8,7 @@ import ( var awsCmd = &cobra.Command{ Use: "aws", Short: "Run AWS-specific commands for interacting with cloud resources", - Long: `This command executes 'aws' CLI commands`, + Long: `This command allows interaction with AWS resources through various CLI commands.`, FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, } From 6f32228dbf2a268fa9e6abbcf8a35e8ef3a679f4 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:57:54 -0600 Subject: [PATCH 13/14] Update cmd/aws_eks.go --- cmd/aws_eks.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/aws_eks.go b/cmd/aws_eks.go index 3fbc6f8bf..cb0388029 100644 --- a/cmd/aws_eks.go +++ b/cmd/aws_eks.go @@ -8,7 +8,7 @@ import ( var awsEksCmd = &cobra.Command{ 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. + 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. From 8ae7656a5779dd2ca2367c4c29770386a8ee8c99 Mon Sep 17 00:00:00 2001 From: "Erik Osterman (CEO @ Cloud Posse)" Date: Mon, 16 Dec 2024 13:58:01 -0600 Subject: [PATCH 14/14] Update cmd/describe_component.go --- cmd/describe_component.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/describe_component.go b/cmd/describe_component.go index 81cef349f..894ace5ac 100644 --- a/cmd/describe_component.go +++ b/cmd/describe_component.go @@ -12,7 +12,7 @@ import ( var describeComponentCmd = &cobra.Command{ Use: "component", 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.`, + 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