feat: add config shorthand (#210)

Signed-off-by: lvlcn-t <75443136+lvlcn-t@users.noreply.github.com>
caas-team · Oct 16, 2024 · 120b24c · 120b24c
1 parent fd9c019
commit 120b24c
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -43,7 +43,7 @@ func NewCmdRoot(version string) *cobra.Command {
 		initConfig(cfgFile)
 	})
 
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.sparrow.yaml)")
+	rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "config file (default is $HOME/.sparrow.yaml)")
 
 	return rootCmd
 }

diff --git a/docs/sparrow.md b/docs/sparrow.md
@@ -10,7 +10,7 @@ The check results are exposed via an API.
 ### Options
 
 ```
-      --config string   config file (default is $HOME/.sparrow.yaml)
+  -c, --config string   config file (default is $HOME/.sparrow.yaml)
   -h, --help            help for sparrow
 ```
 

diff --git a/docs/sparrow_run.md b/docs/sparrow_run.md
@@ -29,7 +29,7 @@ sparrow run [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.sparrow.yaml)
+  -c, --config string   config file (default is $HOME/.sparrow.yaml)
 ```
 
 ### SEE ALSO