Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve command line interface and help #85

Open
neckhair opened this issue Apr 11, 2023 · 1 comment
Open

Improve command line interface and help #85

neckhair opened this issue Apr 11, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@neckhair
Copy link
Member

When I first tried running this project I only got an error "Fatal Error, no deployment defined". This was confusing because the help command did not say anything about a deployment. Also this error message seems to come from deep within the checking code.

A more helpful implementation would define required CLI arguments as required and show them in the help message like this:

USAGE:
   livelint check [command options] <deployment>

I was digging a little through the docs of the CLI framework we're using and did not find an automatic way to define an argument as required. But there is an option to show the arguments in the help output (ArgsUsage).

Maybe we can discuss replacing this framework with Cobra, which does these things a little better and also helps with separating the commands into different files. But maybe there are arguments for the one we're using too.

@neckhair neckhair added the enhancement New feature or request label Apr 11, 2023
qasimwarraich added a commit that referenced this issue Apr 28, 2023
qasimwarraich added a commit that referenced this issue Apr 28, 2023
@qasimwarraich
Copy link
Member

qasimwarraich commented Apr 28, 2023

Thanks, @neckhair! I have taken this feedback into account in the new UI feature branch @cldmstr and I have started.

Output to livelint and livelint c now appear as so:

image

qasimwarraich added a commit that referenced this issue Apr 28, 2023
qasimwarraich added a commit that referenced this issue Apr 28, 2023
qasimwarraich added a commit that referenced this issue May 8, 2023
cloudlena pushed a commit that referenced this issue Feb 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants