Browse Source

udpate docs

tags/v1.3.0
Norwin Roosen 5 months ago
parent
commit
b29081550b

+ 1
- 0
cmd/cmd_root.go View File

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

+ 1
- 1
docs/osem_notify.md View File

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

+ 2
- 1
docs/osem_notify_check.md View File

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

+ 42
- 0
docs/osem_notify_check_all.md View File

@@ -0,0 +1,42 @@
1
+## osem_notify check all
2
+
3
+one-off check on all boxes registered on the opensensemap instance
4
+
5
+### Synopsis
6
+
7
+one-off check on all boxes registered on the opensensemap instance
8
+
9
+```
10
+osem_notify check all [flags]
11
+```
12
+
13
+### Options
14
+
15
+```
16
+  -h, --help   help for all
17
+```
18
+
19
+### Options inherited from parent commands
20
+
21
+```
22
+  -a, --api string         openSenseMap API to query against (default "https://api.opensensemap.org")
23
+  -c, --config string      path to config file (default $HOME/.osem_notify.yml)
24
+  -d, --debug              enable verbose logging
25
+  -l, --logformat string   log format, can be plain or json (default "plain")
26
+      --no-cache           send all notifications, ignoring results from previous runs. also don't update the cache.
27
+  -n, --notify string      If set, will send out notifications for the specified type of check result,
28
+                           otherwise results are printed to stdout only.
29
+                           Allowed values are "all", "error", "ok".
30
+                           You might want to run 'osem_notify debug notifications' first to verify everything works.
31
+                           
32
+                           Notifications for failing checks are sent only once, and then cached until the issue got
33
+                           resolved, unless --no-cache is set.
34
+                           To clear the cache, run 'osem_notify debug cache --clear'.
35
+                           
36
+```
37
+
38
+### SEE ALSO
39
+
40
+* [osem_notify check](osem_notify_check.md)	 - One-off check for events on boxes
41
+
42
+###### Auto generated by spf13/cobra on 10-Feb-2019

+ 1
- 1
docs/osem_notify_check_boxes.md View File

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

+ 1
- 1
docs/osem_notify_debug.md View File

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

+ 1
- 1
docs/osem_notify_debug_cache.md View File

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

+ 1
- 1
docs/osem_notify_debug_notifications.md View File

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

+ 1
- 1
docs/osem_notify_version.md View File

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

+ 2
- 1
docs/osem_notify_watch.md View File

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

+ 43
- 0
docs/osem_notify_watch_all.md View File

@@ -0,0 +1,43 @@
1
+## osem_notify watch all
2
+
3
+watch all boxes registered on the map
4
+
5
+### Synopsis
6
+
7
+watch all boxes registered on the map
8
+
9
+```
10
+osem_notify watch all [flags]
11
+```
12
+
13
+### Options
14
+
15
+```
16
+  -h, --help   help for all
17
+```
18
+
19
+### Options inherited from parent commands
20
+
21
+```
22
+  -a, --api string         openSenseMap API to query against (default "https://api.opensensemap.org")
23
+  -c, --config string      path to config file (default $HOME/.osem_notify.yml)
24
+  -d, --debug              enable verbose logging
25
+  -i, --interval int       interval to run checks in minutes (default 30)
26
+  -l, --logformat string   log format, can be plain or json (default "plain")
27
+      --no-cache           send all notifications, ignoring results from previous runs. also don't update the cache.
28
+  -n, --notify string      If set, will send out notifications for the specified type of check result,
29
+                           otherwise results are printed to stdout only.
30
+                           Allowed values are "all", "error", "ok".
31
+                           You might want to run 'osem_notify debug notifications' first to verify everything works.
32
+                           
33
+                           Notifications for failing checks are sent only once, and then cached until the issue got
34
+                           resolved, unless --no-cache is set.
35
+                           To clear the cache, run 'osem_notify debug cache --clear'.
36
+                           
37
+```
38
+
39
+### SEE ALSO
40
+
41
+* [osem_notify watch](osem_notify_watch.md)	 - Watch boxes for events at an interval
42
+
43
+###### Auto generated by spf13/cobra on 10-Feb-2019

+ 1
- 1
docs/osem_notify_watch_boxes.md View File

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

Loading…
Cancel
Save