docs: added examples to root command

pcanilho · Aug 26, 2023 · 6ee0a7e · 6ee0a7e
1 parent 7a2af24
commit 6ee0a7e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -31,6 +31,11 @@ var (
 
 var rootCmd = &cobra.Command{
 	Use: "gh-tidy",
+	Example: `# direnv allow || read -s GITHUB_TOKEN; export GITHUB_TOKEN
+$ gh tidy stale branches <owner/repo> -t 72h
+$ gh tidy stale prs      <owner/repo> -t 72h -s OPEN -s MERGED
+$ gh tidy stale tags     <owner/repo> -t 72h
+$ gh tidy delete         <owner/repo> -t 72h --ref <branch_name> --ref <tag_name>`,
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) (err error) {
 		// Format
 		switch strings.TrimSpace(strings.ToLower(format)) {