Updating documentation.
This commit is contained in:
parent
9fb6975188
commit
9dbf1542b2
24
README.md
24
README.md
@ -21,11 +21,13 @@ USAGE:
|
|||||||
bgutil-rs <SUBCOMMAND>
|
bgutil-rs <SUBCOMMAND>
|
||||||
|
|
||||||
SUBCOMMANDS:
|
SUBCOMMANDS:
|
||||||
|
clean Stats
|
||||||
delete Delete metric(s)
|
delete Delete metric(s)
|
||||||
help Prints this message or the help of the given subcommand(s)
|
help Prints this message or the help of the given subcommand(s)
|
||||||
info Information about a metric
|
info Information about a metric
|
||||||
list List metrics with given pattern
|
list List metrics with given pattern
|
||||||
read Read a metric contents
|
read Read a metric contents
|
||||||
|
stats Stats
|
||||||
write Write a metric and its value
|
write Write a metric and its value
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -150,6 +152,25 @@ ARGS:
|
|||||||
<metric>
|
<metric>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Clean
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ cargo run -- clean --help
|
||||||
|
bgutil-rs-clean
|
||||||
|
Stats
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
bgutil-rs clean [FLAGS] [OPTIONS]
|
||||||
|
|
||||||
|
FLAGS:
|
||||||
|
--clean-directories
|
||||||
|
--clean-metrics
|
||||||
|
|
||||||
|
OPTIONS:
|
||||||
|
--end-key <end-key>
|
||||||
|
--start-key <start-key>
|
||||||
|
```
|
||||||
|
|
||||||
## Todo
|
## Todo
|
||||||
|
|
||||||
* command: read
|
* command: read
|
||||||
@ -160,3 +181,6 @@ ARGS:
|
|||||||
- Arguments handling
|
- Arguments handling
|
||||||
* command: delete
|
* command: delete
|
||||||
- with recursive
|
- with recursive
|
||||||
|
* command: clean
|
||||||
|
- progress bar
|
||||||
|
* ...
|
Loading…
Reference in New Issue
Block a user