-
Notifications
You must be signed in to change notification settings - Fork 568
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
Rename --output
and --file
flags for better understanding
#1062
Comments
Thanks @Dentrax! I suspect this is related to the conversations we're having here? I'm a little hesitant to make this kind of breaking change even though we're pre v1.0 since it's a large shift from what we currently have as far as the CLI surface area and its interfaces. I do admit that I have my own biases about the current state of the flags cc @anchore/ci-tools-project if anyone wants to weigh in here since I don't have a great answer on 👍 or 👎 for this request. |
This makes a lot of sense to me. The current flags are confusing. |
I agree the existing flags aren't ideal, but I think reusing one of them would create a horrible transition. I think it would make more sense to create two new flags --output-file Then in a few releases deprecate the --output and --file |
I'm good with the above proposal from @joshbressers with deprecation and eventual sunset of the old flags. @wagoodman since we're still pre v1 I don't think this would be the worst change, we just need to communicate via the tool the deprecated status for a couple of releases and then remove them. |
I think there's some misunderstanding about what the |
I think first steps here is getting a readme update that clearly explains what Keith mentioned above. That will take away some of the confusion. We keep |
Hey all, after some discussion we decided to try improving the |
What would you like to be added:
--output
->--format
--file
->--output
syft-json cyclonedx-xml cyclonedx-json github github-json spdx-tag-value spdx-json table text
file to write the default report output to
Why is this needed:
It's a bit hard to distinguish both of
--output
and--file
flags in the first place.output
seems like "i want to write output to a file name arg0";file
is really hard to understand what it is for.Additional context:
-
cc @developer-guy
The text was updated successfully, but these errors were encountered: