📝 Update flags (#41)

stoe · Mar 19, 2023 · db5a476 · db5a476
1 parent 28d343b
commit db5a476
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -102,8 +102,10 @@ func Execute() {
 func init() {
 	cobra.OnInitialize(initConfig)
 
-	RootCmd.PersistentFlags().BoolVar(&noCache, "no-cache", false, "Do not cache results for one hour (default: false)")
-	RootCmd.PersistentFlags().BoolVar(&silent, "silent", false, "Do not print any output (default: false)")
+	RootCmd.PersistentFlags().BoolVar(&noCache, "no-cache", false,
+		`Do not cache results for one hour (default "false")`,
+	)
+	RootCmd.PersistentFlags().BoolVar(&silent, "silent", false, `Do not print any output (default: "false")`)
 
 	RootCmd.PersistentFlags().StringVarP(
 		&enterprise, "enterprise", "e", "",
@@ -128,7 +130,10 @@ func init() {
 		),
 	)
 
-	RootCmd.PersistentFlags().StringVarP(&token, "token", "t", "", "GitHub Personal Access Token (default: gh auth token)")
+	RootCmd.PersistentFlags().StringVarP(
+		&token, "token", "t", "",
+		`GitHub Personal Access Token (default "gh auth token")`,
+	)
 	RootCmd.PersistentFlags().StringVar(&hostname, "hostname", "github.com", "GitHub Enterprise Server hostname")
 
 	RootCmd.PersistentFlags().StringVar(&csvPath, "csv", "", "Path to CSV file")

diff --git a/readme.md b/readme.md
@@ -35,13 +35,13 @@ Flags:
       --csv string          Path to CSV file
   -e, --enterprise string   GitHub Enterprise Cloud account (requires read:enterprise scope)
   -h, --help                help for gh-report
-      --hostname string     GitHub Enterprise Server hostname
+      --hostname string     GitHub Enterprise Server hostname (default "github.com")
       --json string         Path to JSON file
-      --no-cache            Do not cache results for one hour (default: false)
+      --no-cache            Do not cache results for one hour (default "false")
   -o, --owner string        GitHub account organization (requires read:org scope) or user account (requires n/a scope)
   -r, --repo string         GitHub repository (owner/repo), requires repo scope
-      --silent              Do not print any output (default: false)
-  -t, --token string        GitHub Personal Access Token (default: gh auth token)
+      --silent              Do not print any output (default: "false")
+  -t, --token string        GitHub Personal Access Token (default "gh auth token")
   -v, --version             version for gh-report
 
 Use "gh-report [command] --help" for more information about a command.