opensensemap/osem_notify
1
0
Fork 0
Code Issues Pull requests Releases Activity

udpate docs

Browse source
This commit is contained in:
Norwin 2019-02-10 14:21:58 +01:00
parent 2c2508c471
commit b29081550b
12 changed files with 97 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
cmd/cmd_root.go
View file

@ -5,6 +5,7 @@ import (
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
// "github.com/spf13/cobra/doc"
"github.com/spf13/viper"
"github.com/noerw/osem_notify/utils"

2
docs/osem_notify.md
View file

@ -37,4 +37,4 @@ osem_notify [flags]
* [osem_notify version](osem_notify_version.md) - Get build and version information
* [osem_notify watch](osem_notify_watch.md) - Watch boxes for events at an interval
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019

3
docs/osem_notify_check.md
View file

@ -34,6 +34,7 @@ One-off check for events on boxes
### SEE ALSO
* [osem_notify](osem_notify.md) - Root command displaying help
* [osem_notify check all](osem_notify_check_all.md) - one-off check on all boxes registered on the opensensemap instance
* [osem_notify check boxes](osem_notify_check_boxes.md) - one-off check on one or more box IDs
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019

42
docs/osem_notify_check_all.md Normal file
View file

@ -0,0 +1,42 @@
## osem_notify check all
one-off check on all boxes registered on the opensensemap instance
### Synopsis
one-off check on all boxes registered on the opensensemap instance
```
osem_notify check all [flags]
```
### Options
```
-h, --help help for all
```
### Options inherited from parent commands
```
-a, --api string openSenseMap API to query against (default "https://api.opensensemap.org")
-c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging
-l, --logformat string log format, can be plain or json (default "plain")
--no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
-n, --notify string If set, will send out notifications for the specified type of check result,
otherwise results are printed to stdout only.
Allowed values are "all", "error", "ok".
You might want to run 'osem_notify debug notifications' first to verify everything works.
Notifications for failing checks are sent only once, and then cached until the issue got
resolved, unless --no-cache is set.
To clear the cache, run 'osem_notify debug cache --clear'.
```
### SEE ALSO
* [osem_notify check](osem_notify_check.md) - One-off check for events on boxes
###### Auto generated by spf13/cobra on 10-Feb-2019

2
docs/osem_notify_check_boxes.md
View file

@ -39,4 +39,4 @@ osem_notify check boxes <boxId> [...<boxIds>] [flags]
* [osem_notify check](osem_notify_check.md) - One-off check for events on boxes
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019

2
docs/osem_notify_debug.md
View file

@ -41,4 +41,4 @@ osem_notify debug [flags]
* [osem_notify debug cache](osem_notify_debug_cache.md) - Print or clear the notifications cache
* [osem_notify debug notifications](osem_notify_debug_notifications.md) - Verify that notifications are working
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019

2
docs/osem_notify_debug_cache.md
View file

@ -40,4 +40,4 @@ osem_notify debug cache [flags]
* [osem_notify debug](osem_notify_debug.md) - Run some debugging checks on osem_notify itself
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019

2
docs/osem_notify_debug_notifications.md
View file

@ -40,4 +40,4 @@ osem_notify debug notifications [flags]
* [osem_notify debug](osem_notify_debug.md) - Run some debugging checks on osem_notify itself
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019

2
docs/osem_notify_version.md
View file

@ -39,4 +39,4 @@ osem_notify version [flags]
* [osem_notify](osem_notify.md) - Root command displaying help
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019

3
docs/osem_notify_watch.md
View file

@ -35,6 +35,7 @@ Watch boxes for events at an interval
### SEE ALSO
* [osem_notify](osem_notify.md) - Root command displaying help
* [osem_notify watch all](osem_notify_watch_all.md) - watch all boxes registered on the map
* [osem_notify watch boxes](osem_notify_watch_boxes.md) - watch a list of box IDs for events
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019

43
docs/osem_notify_watch_all.md Normal file
View file

@ -0,0 +1,43 @@
## osem_notify watch all
watch all boxes registered on the map
### Synopsis
watch all boxes registered on the map
```
osem_notify watch all [flags]
```
### Options
```
-h, --help help for all
```
### Options inherited from parent commands
```
-a, --api string openSenseMap API to query against (default "https://api.opensensemap.org")
-c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging
-i, --interval int interval to run checks in minutes (default 30)
-l, --logformat string log format, can be plain or json (default "plain")
--no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
-n, --notify string If set, will send out notifications for the specified type of check result,
otherwise results are printed to stdout only.
Allowed values are "all", "error", "ok".
You might want to run 'osem_notify debug notifications' first to verify everything works.
Notifications for failing checks are sent only once, and then cached until the issue got
resolved, unless --no-cache is set.
To clear the cache, run 'osem_notify debug cache --clear'.
```
### SEE ALSO
* [osem_notify watch](osem_notify_watch.md) - Watch boxes for events at an interval
###### Auto generated by spf13/cobra on 10-Feb-2019

2
docs/osem_notify_watch_boxes.md
View file

@ -40,4 +40,4 @@ osem_notify watch boxes <boxId> [...<boxIds>] [flags]
* [osem_notify watch](osem_notify_watch.md) - Watch boxes for events at an interval
###### Auto generated by spf13/cobra on 30-Jun-2018
###### Auto generated by spf13/cobra on 10-Feb-2019