example hint updated

Author: samtholiya

cmd/atlantis.go

@@ -14,5 +14,6 @@ var atlantisCmd = &cobra.Command{
 }
 
 func init() {
+	atlantisCmd.PersistentFlags().Bool("", false, doubleDashHint)
 	RootCmd.AddCommand(atlantisCmd)
 }

cmd/aws.go

@@ -14,5 +14,6 @@ var awsCmd = &cobra.Command{
 }
 
 func init() {
+	awsCmd.PersistentFlags().Bool("", false, doubleDashHint)
 	RootCmd.AddCommand(awsCmd)
 }

cmd/helmfile.go

@@ -20,6 +20,7 @@ func init() {
 	// https://github.com/spf13/cobra/issues/739
 	helmfileCmd.DisableFlagParsing = true
 	helmfileCmd.PersistentFlags().StringP("stack", "s", "", "atmos helmfile <helmfile_command> <component> -s <stack>")
+	helmfileCmd.PersistentFlags().Bool("", false, doubleDashHint)
 	RootCmd.AddCommand(helmfileCmd)
 }
 

cmd/markdown_help.go

@@ -16,6 +16,8 @@ type ExampleContent struct {
 	Suggestion string
 }
 
+var doubleDashHint string = "Double dashes can be used to signify the end of Atmos-specific options and the beginning of additional native arguments and flags for the specific command being run."
+
 var examples map[string]ExampleContent = map[string]ExampleContent{
 	"atmos_terraform": {
 		Content:    terraform,

cmd/terraform.go

@@ -18,6 +18,7 @@ var terraformCmd = &cobra.Command{
 	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},
+	Example:            `atmos terraform [sub-command] <component> -s <stack>`,
 	PostRunE: func(cmd *cobra.Command, args []string) error {
 		info := getConfigAndStacksInfo("terraform", cmd, args)
 		return hooks.RunE(cmd, args, &info)
@@ -50,6 +51,7 @@ func init() {
 	// https://github.com/spf13/cobra/issues/739
 	terraformCmd.DisableFlagParsing = true
 	terraformCmd.PersistentFlags().StringP("stack", "s", "", "atmos terraform <terraform_command> <component> -s <stack>")
+	terraformCmd.PersistentFlags().Bool("", false, doubleDashHint)
 	attachTerraformCommands(terraformCmd)
 	RootCmd.AddCommand(terraformCmd)
 }

tests/test-cases/help-and-usage.yaml

@@ -566,4 +566,4 @@ tests:
       - "--check"
       - "--non-existent"
     expect:
-      exit_code: 1
+      exit_code: 1