feat: enhance help output with detailed usage examples and descriptions

Author: rajamohan-rj

cmd/kdiff/main.go

@@ -18,7 +18,36 @@ var (
 var rootCmd = &cobra.Command{
 	Use:   "kdiff <namespace1> <resource1> <namespace2> <resource2>",
 	Short: "Kubernetes resource differ",
-	Long:  `kdiff is a tool to compare Kubernetes resources between different namespaces.`,
+	Long: `kdiff is a tool to compare Kubernetes resources between different namespaces.
+
+Features:
+  • Compare Kubernetes resources between any two namespaces
+  • Colored diff output for better readability
+  • Optional kubectl neat integration to clean output
+  • Multiple output formats (unified, context, side-by-side)
+  • Support for all Kubernetes resource types
+  • Verbose logging for debugging
+
+Examples:
+  # Compare deployments between staging and production
+  kdiff staging my-app production my-app
+
+  # Compare services with verbose output
+  kdiff --verbose dev my-service prod my-service
+
+  # Compare without colored output
+  kdiff --no-color namespace1 deployment/app namespace2 deployment/app
+
+  # Use context diff format
+  kdiff --output context ns1 svc/api ns2 svc/api
+
+  # Compare with side-by-side format and skip kubectl neat
+  kdiff --output side-by-side --no-neat ns1 pod/web ns2 pod/web
+
+Prerequisites:
+  • kubectl command-line tool
+  • kubectl neat plugin (optional, for cleaner YAML output)
+  • colordiff (optional, for colored output)`,
 	Args: func(cmd *cobra.Command, args []string) error {
 		// Allow version flag to bypass argument validation
 		showVersion, _ := cmd.Flags().GetBool("version")
@@ -42,11 +71,11 @@ var rootCmd = &cobra.Command{
 }
 
 func init() {
-	rootCmd.Flags().BoolVar(&opts.NoColor, "no-color", false, "disable colored output")
-	rootCmd.Flags().BoolVar(&opts.NoNeat, "no-neat", false, "skip kubectl neat processing")
+	rootCmd.Flags().BoolVar(&opts.NoColor, "no-color", false, "disable colored output (useful for CI/CD pipelines)")
+	rootCmd.Flags().BoolVar(&opts.NoNeat, "no-neat", false, "skip kubectl neat processing (show raw YAML)")
 	rootCmd.Flags().StringVar(&opts.OutputFormat, "output", "unified", "output format: unified, context, side-by-side")
-	rootCmd.Flags().BoolVar(&opts.Verbose, "verbose", false, "verbose logging")
-	rootCmd.Flags().Bool("version", false, "print version")
+	rootCmd.Flags().BoolVar(&opts.Verbose, "verbose", false, "enable verbose logging for debugging")
+	rootCmd.Flags().Bool("version", false, "show version information")
 }
 
 // Execute runs the root command - called from main.go