docs(clustertool): add more in-code documentation

2024-10-25 18:29:29 +02:00
parent e09a48e770
commit 9d93573aac
28 changed files with 90 additions and 79 deletions
@@ -14,9 +14,10 @@ var advPrecommitLongHelp = strings.TrimSpace(`
 `)

 var precommit = &cobra.Command{
-    Use:   "precommit",
-    Short: "Runs the PreCommit encryption check",
-    Long:  advPrecommitLongHelp,
+    Use:     "precommit",
+    Short:   "Runs the PreCommit encryption check",
+    Example: "clustertool adv precommit",
+    Long:    advPrecommitLongHelp,
    Run: func(cmd *cobra.Command, args []string) {
        if err := sops.CheckFilesAndReportEncryption(true, true); err != nil {
            log.Info().Msgf("Error checking files: %v\n", err)