Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

CLI help should list available differ types #293

Closed
cben opened this issue Feb 5, 2019 · 1 comment · Fixed by #303
Closed

CLI help should list available differ types #293

cben opened this issue Feb 5, 2019 · 1 comment · Fixed by #303

Comments

@cben
Copy link
Contributor

cben commented Feb 5, 2019

Expected behavior

Having installed the tool, I tried to use its --help to see how to use it. By default it only showed Size difference so I figured I need --type. But what values can I use there?
Ideally container-diff diff --help and container-diff help diff would list available differ/analyzer types.
Or point to another command that would list them (eg. container-diff help analyzers or container-diff diff --type help or whatever).

Actual behavior

$ container-diff help diff
Compares two images using the specifed analyzers as indicated via flags (see documentation for available ones).
...
  -t, --type Diff Types    This flag sets the list of analyzer types to use. Set it repeatedly to use multiple analyzers.

Information

  • container-diff version: go get from current master, v0.14.0-23-g 5b5e627
    BTW, you don't have a --version flag, making this question hard to answer :)
  • Operating system: linux, fedora 29
@nkubala
Copy link
Contributor

nkubala commented Mar 1, 2019

@cben thanks for the issue. the README does have a list of supported differs in the tool, but you're right it would be a nicer UX to have it supported through the --help flag.

would you be interested in sending a short PR to add this into the help command?

also, container-diff version (subcommand, not a flag) should do the trick :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants