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 --output CLI help and deprecate --file #2165

Closed
tgerla opened this issue Sep 21, 2023 · 0 comments · Fixed by #2187
Closed

Improve --output CLI help and deprecate --file #2165

tgerla opened this issue Sep 21, 2023 · 0 comments · Fixed by #2187
Labels
enhancement New feature or request good-first-issue Good for newcomers

Comments

@tgerla
Copy link
Contributor

tgerla commented Sep 21, 2023

Based on the discussion in #1062, we want to improve the CLI help text for the --output parameter, and deprecate the --file parameter. The --output text currently looks like:

  -o, --output stringArray       report output format, options=[syft-json cyclonedx-xml cyclonedx-json github-json spdx-tag-value spdx-json syft-table syft-text template] (default [syft-table])

...and it's not clear from that help text that you can do:

-o json=sbom.syft.json -o spdx-json=sbom.spdx.json (as described in https://github.com/anchore/syft#multiple-outputs)

This means that the --file parameter is kind of redundant and confusing, so we should deprecate that option.

@tgerla tgerla added the enhancement New feature or request label Sep 21, 2023
@spiffcs spiffcs added good-first-issue Good for newcomers hacktoberfest Pointing Users to Hacktoberfest activities and removed hacktoberfest Pointing Users to Hacktoberfest activities labels Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good-first-issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants