cli icon indicating copy to clipboard operation
cli copied to clipboard

-v should mean verbose, not version

Open wilzbach opened this issue 6 years ago • 7 comments

If a user wants to check the version, --version (or a special version command are OK). That doesn't happen often.

Accessing debug output, however, is something that would take advantage of the convenient -v flag and is the expected behavior if one does:

oms run -v
oms subscribe -v

wilzbach avatar Oct 29 '19 08:10 wilzbach

We had -V and -v for version @judepereira requested we keep -v for version. I would prefer we avoid renaming between releases. We should decide on one for good this time

ghost avatar Oct 29 '19 09:10 ghost

@wilzbach What would you expect in --verbose?

judepereira avatar Oct 29 '19 13:10 judepereira

@wilzbach What would you expect in --verbose?

Same as with -v ;-) (more verbose output)

wilzbach avatar Oct 29 '19 13:10 wilzbach

BTW I just found out that we have both: --debug (container logs) and --verbose (docker logs) which isn't very friendly to users either :/

wilzbach avatar Oct 29 '19 14:10 wilzbach

@wilzbach Can you please elaborate on what part of it is user-unfriendly? Both are documented well in --help.

--verbose for Docker logs is for when you are building a microservice and it's docker file, but after that is built, you should not want the docker logs because they should stay stable, especially since we already show the last line in the spinner now. It's only there to help debug the build process and not the Application so should very very rarely be used. If you have to use it often, then there's something wrong with the build config.

--debug is for when you are debugging the Application itself and has nothing to do with the Docker daemon part of things.

With that in mind, If you were to propose automatically turning on --debug when --verbose is specified, I'd be in favor of that.

But If there's an overwhelming majority, I'm okay with merging both into one.

ghost avatar Oct 31 '19 13:10 ghost

@wilzbach Can you please elaborate on what part of it is user-unfriendly? Both are documented well in --help.

Well, it's two flags for more or less the same thing (your app isn't working). It's not user-friendly because a user has to read the documentation to know this in contrast to:

oms run --verbose=docker
oms run --docker-logs
oms run --debug=docker

With that in mind, If you were to propose automatically turning on --debug when --verbose is specified, I'd be in favor of that.

What do you think about either (a) or (b)?

a)

-v|--verbose (activates both)
--verbose=app
--verbose=docker

b)

-v|--verbose (activates only app)
--verbose=all (activates both)
--verbose=app
--verbose=docker

wilzbach avatar Oct 31 '19 13:10 wilzbach

Both are really nice proposal, I'm leaning in favor of A 👍 (tho the -v part is still under debate)

ghost avatar Oct 31 '19 13:10 ghost