fix(6235): added long description for the validate command

elastic · Jan 16, 2025 · 47afb60 · 47afb60
1 parent 7ee581e
commit 47afb60
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/internal/pkg/agent/cmd/validate.go b/internal/pkg/agent/cmd/validate.go
@@ -17,6 +17,7 @@ func newValidateCommandWithArgs(_ []string, _ *cli.IOStreams) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:           "validate",
 		Short:         "Validates the OpenTelemetry collector configuration without running the collector",
+		Long:          "Validates the OpenTelemetry collector configuration without running the collector. Validation will fail for otel-elastic hybrid configuration files. This command will return true for valid otel configurations only.",
 		SilenceUsage:  true, // do not display usage on error
 		SilenceErrors: true,
 		RunE: func(cmd *cobra.Command, _ []string) error {