From 9dbf1542b2b659c1139f3c4a899d8f77a494bd8a Mon Sep 17 00:00:00 2001 From: Patrick MARIE Date: Wed, 24 Feb 2021 21:43:31 +0100 Subject: [PATCH] Updating documentation. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index fb59df7..97f9f89 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,13 @@ USAGE: bgutil-rs SUBCOMMANDS: + clean Stats delete Delete metric(s) help Prints this message or the help of the given subcommand(s) info Information about a metric list List metrics with given pattern read Read a metric contents + stats Stats write Write a metric and its value ``` @@ -150,6 +152,25 @@ ARGS: ``` +### Clean + +```sh +$ cargo run -- clean --help +bgutil-rs-clean +Stats + +USAGE: + bgutil-rs clean [FLAGS] [OPTIONS] + +FLAGS: + --clean-directories + --clean-metrics + +OPTIONS: + --end-key + --start-key +``` + ## Todo * command: read @@ -160,3 +181,6 @@ ARGS: - Arguments handling * command: delete - with recursive +* command: clean + - progress bar +* ... \ No newline at end of file