Skip to content

Commit

Permalink
Better --help text in krr (#296)
Browse files Browse the repository at this point in the history
# Motivation
Users often run `krr --help` to learn about KRR cli flags, but that
command doesn't output most flags! Most of the flags are only shown for
`krr simple --help`. This PR tells users where to look for the real cli
flags.

# Alternatives
Ideally `krr --help` would show all cli flags, but I don't know how to
do this with the library we use (typer) and I suspect it isn't possible.
So while I would prefer doing that, this was the only solution I found.
  • Loading branch information
aantn authored Jun 20, 2024
1 parent 02f6efe commit c9554c0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion robusta_krr/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
from robusta_krr.core.runner import Runner
from robusta_krr.utils.version import get_version

app = typer.Typer(pretty_exceptions_show_locals=False, pretty_exceptions_short=True, no_args_is_help=True)
app = typer.Typer(pretty_exceptions_show_locals=False, pretty_exceptions_short=True, no_args_is_help=True, help="IMPORTANT: Run `krr simple --help` to see all cli flags!")

# NOTE: Disable insecure request warnings, as it might be expected to use self-signed certificates inside the cluster
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
Expand Down

0 comments on commit c9554c0

Please sign in to comment.