mycroft/bgutil-rs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updating README.md.

Browse Source
This commit is contained in:
Patrick MARIE 2021-02-26 12:02:31 +01:00
parent a526f388df
commit 7c78a7f17a
1 changed files with 52 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -11,24 +11,35 @@ Don't forget to download & install [cassandra-cpp](https://downloads.datastax.co
## Run ## Run
```sh ```sh
$ cargo build
Finished dev [unoptimized + debuginfo] target(s) in 0.04s
$ cargo run -- --help
bgutil-rs bgutil-rs
USAGE: USAGE:
bgutil-rs <SUBCOMMAND> bgutil-rs [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
--dry-run Do not write in database (local-clean only)
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--contact-metadata <contact-metadata>
[env: CASSANDRA_CONTACT_METADATA=localhost]
--contact-points <contact-points>
[env: CASSANDRA_CONTACT_POINTS=localhost]
SUBCOMMANDS: SUBCOMMANDS:
clean Stats clean Clean outdated metrics & empty directories
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 local-clean Clean a directory of outdated metrics & empty sub-directories
stats Stats read Read a metric contents
write Write a metric and its value stats Stats
write Write a metric and its value
``` ```
### Info ### Info
@ -156,7 +167,7 @@ ARGS:
```sh ```sh
$ cargo run -- clean --help $ cargo run -- clean --help
bgutil-rs-clean bgutil-rs-clean
Stats Stats
USAGE: USAGE:
@ -171,6 +182,27 @@ OPTIONS:
--start-key <start-key> --start-key <start-key>
``` ```
### Local-clean
Clean outdated metrics in a given directory.
```sh
$ cargo run -- local-clean --help
bgutil-rs-local-clean
Clean a directory of outdated metrics & empty sub-directories
USAGE:
bgutil-rs local-clean <directory>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
ARGS:
<directory>
```
## Todo ## Todo
* command: read * command: read
@ -183,4 +215,9 @@ OPTIONS:
- with recursive - with recursive
* command: clean * command: clean
- progress bar - progress bar
* ... * ...
## Dedication
This piece of software was written during the mourning of Jean-Yves Moyart, aka Maître Mô, 21/10/1967-20/02/2021. My thoughts were with him, his family, his friends and all of us, who really appreciated him. Rest in Peace.