From 3e9b744ced954b8fec31b107ba5a8a97801d994a Mon Sep 17 00:00:00 2001 From: Greg Clunies Date: Mon, 4 Mar 2024 08:21:15 -0800 Subject: [PATCH] update README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 5a4c7b0..67e5bae 100644 --- a/README.md +++ b/README.md @@ -616,6 +616,27 @@ A description of commands can be seen by running `reflekt --help`. The help page │ --help Show this message and exit. │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ``` + +### `reflekt report` +```bash +❯ reflekt report --help +[08:20:09] INFO Running with reflekt=0.6.0 + + Usage: reflekt report [OPTIONS] + + Generate Markdown report(s) for schema(s). + +╭─ Options ───────────────────────────────────────────────────────────────────────────────────────╮ +│ * --select -s TEXT Schema(s) to generate Markdown report(s) for. Starting with │ +│ 'schemas/' is optional. │ +│ [default: None] │ +│ [required] │ +│ --to-file -f Write report(s) to file instead of terminal. │ +│ --verbose -v Verbose logging. │ +│ --help Show this message and exit. │ +╰─────────────────────────────────────────────────────────────────────────────────────────────────╯ +``` + ---