From 912a191b31fc97876c1862f7116ffb34a46ac585 Mon Sep 17 00:00:00 2001 From: Igor Bronovskyi Date: Tue, 27 Apr 2021 14:28:23 +0300 Subject: [PATCH] Fixed syntax errors in the commands help --- cmd/discord.go | 2 +- cmd/mattermost.go | 2 +- cmd/msteams.go | 2 +- cmd/pushover.go | 2 +- cmd/slack.go | 2 +- docs/services.md | 10 +++++----- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/cmd/discord.go b/cmd/discord.go index 11de496..d83f11a 100644 --- a/cmd/discord.go +++ b/cmd/discord.go @@ -31,7 +31,7 @@ func SendToDiscord() *cli.Command { Description: `Discord uses bot token to authenticate & send messages to defined channels. Multiple channel ids can be used separated by comma ','. All configuration options are also available via environment variables.`, - UsageText: "pingme discord --token '123' --channel '12345,67890' --message 'some message'", + UsageText: "pingme discord --token '123' --channel '12345,67890' --msg 'some message'", Flags: []cli.Flag{ &cli.StringFlag{ Destination: &discordOpts.Token, diff --git a/cmd/mattermost.go b/cmd/mattermost.go index 3862831..9f374ce 100644 --- a/cmd/mattermost.go +++ b/cmd/mattermost.go @@ -57,7 +57,7 @@ func SendToMattermost() *cli.Command { Name: "mattermost", Usage: "Send message to mattermost", UsageText: "pingme mattermost --token '123' --channel '12345567' --url 'localhost' --scheme http " + - "--message 'some message'", + "--msg 'some message'", Description: `Mattermost uses token to authenticate and channel ids for targets. You can specify multiple channels by separating the value with ','.`, Flags: []cli.Flag{ diff --git a/cmd/msteams.go b/cmd/msteams.go index d8e20a4..78cead2 100644 --- a/cmd/msteams.go +++ b/cmd/msteams.go @@ -29,7 +29,7 @@ func SendToTeams() *cli.Command { Usage: "Send message to microsoft teams", Description: `Teams uses webhooks to send messages, you can add multiple webhooks separated by comma ',' or you can add permissions for multiple channels to single webhook.`, - UsageText: "pingme teams --webhook 'https://example.webhook.office.com/xx' --message 'some message'", + UsageText: "pingme teams --webhook 'https://example.webhook.office.com/xx' --msg 'some message'", Flags: []cli.Flag{ &cli.StringFlag{ Destination: &msTeamOpt.Webhook, diff --git a/cmd/pushover.go b/cmd/pushover.go index cee8707..dfed0e7 100644 --- a/cmd/pushover.go +++ b/cmd/pushover.go @@ -26,7 +26,7 @@ func SendToPushOver() *cli.Command { return &cli.Command{ Name: "pushover", Usage: "Send message to pushover", - UsageText: "pingme pushover --token '123' --user '12345,567' --message 'some message'", + UsageText: "pingme pushover --token '123' --user '12345,567' --msg 'some message'", Description: `Pushover uses token to authenticate application and user token to send messages to the user. All configuration options are also available via environment variables.`, Flags: []cli.Flag{ diff --git a/cmd/slack.go b/cmd/slack.go index 42a2c53..d47d77e 100644 --- a/cmd/slack.go +++ b/cmd/slack.go @@ -28,7 +28,7 @@ func SendToSlack() *cli.Command { return &cli.Command{ Name: "slack", Usage: "Send message to slack", - UsageText: "pingme slack --token '123' --channel '12345,67890' --message 'some message'", + UsageText: "pingme slack --token '123' --channel '12345,67890' --msg 'some message'", Description: `Slack uses token to authenticate and send messages to defined channels. Multiple channel ids can be used separated by comma ','. All configuration options are also available via environment variables.`, diff --git a/docs/services.md b/docs/services.md index 4bf5be8..1d893e4 100644 --- a/docs/services.md +++ b/docs/services.md @@ -111,7 +111,7 @@ jobs: ## Pushover ```bash -pingme pushover --token '123' --user '12345567' --title 'some title' --message 'some message' +pingme pushover --token '123' --user '12345567' --title 'some title' --msg 'some message' ``` - Github Action @@ -158,7 +158,7 @@ Latest api version 4 is used for interacting with server, this can also be chan You can specify multiple channels by separating the value with ','. ```bash -pingme mattermost --token '123' --channel '12345,567' --url 'localhost' --scheme 'http' --message 'some message' +pingme mattermost --token '123' --channel '12345,567' --url 'localhost' --scheme 'http' --msg 'some message' ``` - Github Action @@ -207,7 +207,7 @@ Slack uses token to authenticate and send messages to defined channels. Multiple channel ids can be used separated by comma ','. ```bash -pingme slack --token '123' --channel '1234567890' --message 'some message' +pingme slack --token '123' --channel '1234567890' --msg 'some message' ``` - Github Action @@ -251,7 +251,7 @@ Discord uses bot token to authenticate & send messages to defined channels. Multiple channel ids can be used separated by comma ','. ```bash - pingme discord --token '123' --channel '1234567890' --message 'some message' + pingme discord --token '123' --channel '1234567890' --msg 'some message' ``` - Github Action @@ -295,7 +295,7 @@ Teams uses webhooks to send messages, you can add multiple webhooks separated by you can add permissions for multiple channels to single webhook. ```bash -pingme teams --webhook 'https://example.webhook.office.com/xx' --message 'some message' +pingme teams --webhook 'https://example.webhook.office.com/xx' --msg 'some message' ``` - Github Action