Documentation, fix test, return JSON on publish, add --quiet flag for publish

cmd/publish.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"errors"
+	"fmt"
 	"github.com/urfave/cli/v2"
 	"heckel.io/ntfy/client"
 	"strings"
@@ -9,17 +10,19 @@ import (
 
 var cmdPublish = &cli.Command{
 	Name:      "publish",
-	Aliases:   []string{"pub", "send", "push", "trigger"},
+	Aliases:   []string{"pub", "send", "trigger"},
 	Usage:     "Send message via a ntfy server",
-	UsageText: "ntfy send [OPTIONS..] TOPIC MESSAGE",
+	UsageText: "ntfy send [OPTIONS..] TOPIC [MESSAGE]",
 	Action:    execPublish,
 	Flags: []cli.Flag{
+		&cli.StringFlag{Name: "config", Aliases: []string{"c"}, Usage: "client config file"},
 		&cli.StringFlag{Name: "title", Aliases: []string{"t"}, Usage: "message title"},
 		&cli.StringFlag{Name: "priority", Aliases: []string{"p"}, Usage: "priority of the message (1=min, 2=low, 3=default, 4=high, 5=max)"},
-		&cli.StringFlag{Name: "tags", Aliases: []string{"ta"}, Usage: "comma separated list of tags and emojis"},
-		&cli.StringFlag{Name: "delay", Aliases: []string{"at", "in"}, Usage: "delay/schedule message"},
+		&cli.StringFlag{Name: "tags", Aliases: []string{"tag", "T"}, Usage: "comma separated list of tags and emojis"},
+		&cli.StringFlag{Name: "delay", Aliases: []string{"at", "in", "D"}, Usage: "delay/schedule message"},
 		&cli.BoolFlag{Name: "no-cache", Aliases: []string{"C"}, Usage: "do not cache message server-side"},
 		&cli.BoolFlag{Name: "no-firebase", Aliases: []string{"F"}, Usage: "do not forward message to Firebase"},
+		&cli.BoolFlag{Name: "quiet", Aliases: []string{"q"}, Usage: "do print message"},
 	},
 	Description: `Publish a message to a ntfy server.
 
@@ -33,12 +36,19 @@ Examples:
   ntfy trigger mywebhook                                  # Sending without message, useful for webhooks
 
 Please also check out the docs on publishing messages. Especially for the --tags and --delay options, 
-it has incredibly useful information: https://ntfy.sh/docs/publish/.`,
+it has incredibly useful information: https://ntfy.sh/docs/publish/.
+
+The default config file for all client commands is /etc/ntfy/client.yml (if root user),
+or ~/.config/ntfy/client.yml for all other users.`,
 }
 
 func execPublish(c *cli.Context) error {
 	if c.NArg() < 1 {
-		return errors.New("topic missing")
+		return errors.New("must specify topic, type 'ntfy publish --help' for help")
+	}
+	conf, err := loadConfig(c)
+	if err != nil {
+		return err
 	}
 	title := c.String("title")
 	priority := c.String("priority")
@@ -46,6 +56,7 @@ func execPublish(c *cli.Context) error {
 	delay := c.String("delay")
 	noCache := c.Bool("no-cache")
 	noFirebase := c.Bool("no-firebase")
+	quiet := c.Bool("quiet")
 	topic := c.Args().Get(0)
 	message := ""
 	if c.NArg() > 1 {
@@ -70,10 +81,13 @@ func execPublish(c *cli.Context) error {
 	if noFirebase {
 		options = append(options, client.WithNoFirebase())
 	}
-	conf, err := loadConfig(c)
+	cl := client.New(conf)
+	m, err := cl.Publish(topic, message, options...)
 	if err != nil {
 		return err
 	}
-	cl := client.New(conf)
-	return cl.Publish(topic, message, options...)
+	if !quiet {
+		fmt.Fprintln(c.App.Writer, strings.TrimSpace(m.Raw))
+	}
+	return nil
 }

cmd/publish_test.go

@@ -6,7 +6,7 @@ import (
 	"testing"
 )
 
-func TestCLI_Publish_Real_Server(t *testing.T) {
+func TestCLI_Publish_Subscribe_Poll_Real_Server(t *testing.T) {
 	testMessage := util.RandomString(10)
 
 	app, _, _, _ := newTestApp()

cmd/serve.go

@@ -47,6 +47,10 @@ Examples:
 }
 
 func execServe(c *cli.Context) error {
+	if c.NArg() > 0 {
+		return errors.New("no arguments expected, see 'ntfy serve --help' for help")
+	}
+
 	// Read all the options
 	listenHTTP := c.String("listen-http")
 	listenHTTPS := c.String("listen-https")

cmd/subscribe.go

@@ -26,7 +26,7 @@ var cmdSubscribe = &cli.Command{
 	},
 
 	Flags: []cli.Flag{
-		&cli.StringFlag{Name: "config", Aliases: []string{"c"}, Usage: "config file `FILE`"},
+		&cli.StringFlag{Name: "config", Aliases: []string{"c"}, Usage: "client config file"},
 		&cli.StringFlag{Name: "since", Aliases: []string{"s"}, Usage: "return events since `SINCE` (Unix timestamp, or all)"},
 		&cli.BoolFlag{Name: "from-config", Aliases: []string{"C"}, Usage: "read subscriptions from config file (service mode)"},
 		&cli.BoolFlag{Name: "poll", Aliases: []string{"p"}, Usage: "return events and exit, do not listen for new events"},
@@ -72,7 +72,9 @@ ntfy subscribe --from-config
   Examples: 
     ntfy sub --from-config                           # Read topics from config file
     ntfy sub --config=/my/client.yml --from-config   # Read topics from alternate config file
-`,
+
+The default config file for all client commands is /etc/ntfy/client.yml (if root user),
+or ~/.config/ntfy/client.yml for all other users.`,
 }
 
 func execSubscribe(c *cli.Context) error {