update docs

neroist · Jun 25, 2023 · 6cd33ca · 6cd33ca
1 parent 45e6d2c
commit 6cd33ca
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/docs/book.nim b/docs/book.nim
@@ -22,5 +22,6 @@ var book = initBookWithToc:
     entry("Repo", "commands/repo.md")
     entry("License", "commands/license.md")
     entry("Docs", "commands/docs.md")
+  #entry("How to Get Govee API Key", "how_to_get_govee_api_key.md")
 
 nimibookCli(book)
diff --git a/docs/book/commands/turn.md b/docs/book/commands/turn.md
@@ -10,10 +10,10 @@ Options:
   -h, --help                     print this cligen-erated help
   --help-syntax                  advanced: prepend,plurals,..
   --version       bool    false  print version
-  -d=, --device=  int     0      The device to perform the action/command on. Defaults to '0'. '0' refers to the first device on your account, '1' refers to the second, ect. See the full list
-                                 of devices with `nova devices`.
-  -s=, --state=   string  ""     The state you want to put the device in. Has to be the string "on" or "off." If left blank, the command will print the current power state of the device.     
-  -o, --output    bool    true   Whether or not the command will produce output. This also silences errors and will let commands fail silently.
+  -d=, --device=  int     0      The device to perform the action/command on. Defaults to '0'. '0' refers to the first device on your account, '1' refers to the second, ect.
+  -s=, --state=   string  ""     The state you want to put the device in. Has to be the string "on" or "off." If left blank, the command will print the current power state of the device.
+  -t, --toggle    bool    false  Whether or not to toggle the power state of the device (if its on turn it off and vice-versa). This flag takes precedence over the `state` option.
+  -o, --output    bool    true   Whether or not the command will produce output. This also silences errors and will allow the command to fail silently.
 ```
 
 ### Options
@@ -22,10 +22,13 @@ Options:
 The state you want to put the device in.
 Has to be the string "on" or "off." If left blank, the command will print the current power state of the device.
 
+<`-t`, `--toggle`> `toggle` - **Type: bool (true/false/on/off). Optional.**
+Whether or not to toggle the power state of the device (if its on turn it off and vice-versa). This flag takes precedence over the `state` option
+
 <`-d`, `--device`> `device` - **Type: int/integer. Optional.**
 The device to perform the command on. Defaults to '0.' '0' refers to the first device on your account, '1' refers to the second, ect.
 
-<`-o`, `--output`> `output` - **Type: boolean (true/false/on/off). Optional.**
+<`-o`, `--output`> `output` - **Type: bool (true/false/on/off). Optional.**
 Whether or not the command will produce output. This also silences errors and will allow the command fail silently.
 
 ### Usage