main.go

@@ -6,6 +6,7 @@
 package main // import "code.gitea.io/tea"
 
 import (
+	"fmt"
 	"log"
 	"os"
 	"strings"
@@ -24,6 +25,8 @@ var Tags = ""
 func main() {
 	app := cli.NewApp()
 	app.Name = "tea"
+	app.Usage = "command line tool to interact with Gitea"
+	app.Description = appDescription
 	app.CustomAppHelpTemplate = helpTemplate
 	app.Version = Version + formatBuiltWith(Tags)
 	app.Commands = []*cli.Command{
@@ -55,31 +58,60 @@ func formatBuiltWith(Tags string) string {
 	return " built with: " + strings.Replace(Tags, " ", ", ", -1)
 }
 
-var helpTemplate = `NAME:
-   {{.Name}}{{if .Usage}} - {{.Usage}}{{end}}
+var appDescription = `tea is a productivity helper for Gitea.  It can be used to manage most entities on one
+or multiple Gitea instances, and also provides local helpers like 'tea pull checkout'.
+tea makes use of context provided by the repository in $PWD if available, but is still
+usable independently of $PWD. Configuration is persisted in $XDG_CONFIG_HOME/tea.
+`
 
-USAGE:
-   {{if .UsageText}}{{.UsageText}}{{else}}{{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Version}}{{if not .HideVersion}}
+var helpTemplate = bold(`
+   {{.Name}}{{if .Usage}} - {{.Usage}}{{end}}`) + `
+   {{if .Version}}{{if not .HideVersion}}version {{.Version}}{{end}}{{end}}
 
-VERSION:
-   {{.Version}}{{end}}{{end}}{{if .Description}}
+ USAGE
+   {{if .UsageText}}{{.UsageText}}{{else}}{{.HelpName}}{{if .Commands}} command [subcommand] [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Description}}
 
-DESCRIPTION:
-   {{.Description | nindent 3 | trim}}{{end}}{{if len .Authors}}
+ DESCRIPTION
+   {{.Description | nindent 3 | trim}}{{end}}{{if .VisibleCommands}}
 
-AUTHOR{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}:
-   {{range $index, $author := .Authors}}{{if $index}}
-   {{end}}{{$author}}{{end}}{{end}}{{if .VisibleCommands}}
-
-COMMANDS:{{range .VisibleCategories}}{{if .Name}}
+ COMMANDS{{range .VisibleCategories}}{{if .Name}}
    {{.Name}}:{{range .VisibleCommands}}
      {{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{else}}{{range .VisibleCommands}}
    {{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{end}}{{end}}{{end}}{{if .VisibleFlags}}
 
-GLOBAL OPTIONS:
+ OPTIONS
    {{range $index, $option := .VisibleFlags}}{{if $index}}
-   {{end}}{{$option}}{{end}}{{end}}{{if .Copyright}}
+   {{end}}{{$option}}{{end}}{{end}}
 
-COPYRIGHT:
-   {{.Copyright}}{{end}}
+ EXAMPLES
+   tea login add                       # add a login once to get started
+
+   tea pulls                           # list open pulls for the repo in $PWD
+   tea pulls --repo $HOME/foo          # list open pulls for the repo in $HOME/foo
+   tea pulls --remote upstream         # list open pulls for the repo pointed at by
+                                       # your local "upstream" git remote
+   # list open pulls for any gitea repo at the given login instance
+   tea pulls --repo gitea/tea --login gitea.com
+
+   tea milestone issues 0.7.0          # view open issues for milestone '0.7.0'
+   tea issue 189                       # view contents of issue 189
+   tea open 189                        # open web ui for issue 189
+   tea open milestones                 # open web ui for milestones
+
+   # send gitea desktop notifications every 5 minutes (bash + libnotify)
+   while :; do tea notifications --all -o simple | xargs -i notify-send {}; sleep 300; done
+
+ EXIT CODES
+     0 success
+     1 generic error
+   404 entity not found
+
+ ABOUT
+   Written & maintained by The Gitea Authors.
+   If you find a bug or want to contribute, we'll welcome you at https://gitea.com/gitea/tea.
+   More info about Gitea itself on https://gitea.io.
 `
+
+func bold(t string) string {
+	return fmt.Sprintf("\033[1m%s\033[0m", t)
+}