Merge pull request #22 from BrunIF/fix-help-text-usage

fix: syntax errors in the help commands
pull/23/head
Khaliq 4 years ago committed by GitHub
commit 11ca633fca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -31,7 +31,7 @@ func SendToDiscord() *cli.Command {
Description: `Discord uses bot token to authenticate & send messages to defined channels. Description: `Discord uses bot token to authenticate & send messages to defined channels.
Multiple channel ids can be used separated by comma ','. Multiple channel ids can be used separated by comma ','.
All configuration options are also available via environment variables.`, 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{ Flags: []cli.Flag{
&cli.StringFlag{ &cli.StringFlag{
Destination: &discordOpts.Token, Destination: &discordOpts.Token,

@ -57,7 +57,7 @@ func SendToMattermost() *cli.Command {
Name: "mattermost", Name: "mattermost",
Usage: "Send message to mattermost", Usage: "Send message to mattermost",
UsageText: "pingme mattermost --token '123' --channel '12345567' --url 'localhost' --scheme http " + 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. Description: `Mattermost uses token to authenticate and channel ids for targets.
You can specify multiple channels by separating the value with ','.`, You can specify multiple channels by separating the value with ','.`,
Flags: []cli.Flag{ Flags: []cli.Flag{

@ -29,7 +29,7 @@ func SendToTeams() *cli.Command {
Usage: "Send message to microsoft teams", Usage: "Send message to microsoft teams",
Description: `Teams uses webhooks to send messages, you can add multiple webhooks separated by comma ',' or 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.`, 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{ Flags: []cli.Flag{
&cli.StringFlag{ &cli.StringFlag{
Destination: &msTeamOpt.Webhook, Destination: &msTeamOpt.Webhook,

@ -26,7 +26,7 @@ func SendToPushOver() *cli.Command {
return &cli.Command{ return &cli.Command{
Name: "pushover", Name: "pushover",
Usage: "Send message to 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. 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.`, All configuration options are also available via environment variables.`,
Flags: []cli.Flag{ Flags: []cli.Flag{

@ -28,7 +28,7 @@ func SendToSlack() *cli.Command {
return &cli.Command{ return &cli.Command{
Name: "slack", Name: "slack",
Usage: "Send message to 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. Description: `Slack uses token to authenticate and send messages to defined channels.
Multiple channel ids can be used separated by comma ','. Multiple channel ids can be used separated by comma ','.
All configuration options are also available via environment variables.`, All configuration options are also available via environment variables.`,

@ -111,7 +111,7 @@ jobs:
## Pushover ## Pushover
```bash ```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 - 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 ','. You can specify multiple channels by separating the value with ','.
```bash ```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 - 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 ','. Multiple channel ids can be used separated by comma ','.
```bash ```bash
pingme slack --token '123' --channel '1234567890' --message 'some message' pingme slack --token '123' --channel '1234567890' --msg 'some message'
``` ```
- Github Action - 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 ','. Multiple channel ids can be used separated by comma ','.
```bash ```bash
pingme discord --token '123' --channel '1234567890' --message 'some message' pingme discord --token '123' --channel '1234567890' --msg 'some message'
``` ```
- Github Action - 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. you can add permissions for multiple channels to single webhook.
```bash ```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 - Github Action

Loading…
Cancel
Save