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

[docs] Clarify Option Placement in verify file Command Help #414

Open
viveksahu26 opened this issue Nov 19, 2024 · 2 comments
Open

[docs] Clarify Option Placement in verify file Command Help #414

viveksahu26 opened this issue Nov 19, 2024 · 2 comments

Comments

@viveksahu26
Copy link

Description:

The help documentation for the verify file command in cyclonedx-cli appears to incorrectly specify the placement of options like --key-file and --signature-file.

Current Help Text:

Usage:
  cyclonedx-cli [options] verify file <file>

This suggests that options such as --key-file and --signature-file should be placed before the verify file subcommand. For example:

cyclonedx-cli --key-file public_key.pem --signature-file sbom.sig verify file SPDXJSONExample-v2.3.spdx.json

However, this does not work. The correct syntax is:

cyclonedx-cli verify file SPDXJSONExample-v2.3.spdx.json --key-file public_key.pem --signature-file sbom.sig

Expected Behavior:

The help text should clarify that the options --key-file and --signature-file must be placed after the verify file subcommand and <file> argument.

@andreas-hilti
Copy link
Contributor

Compare also #382.

@viveksahu26
Copy link
Author

Yes, it's duplicate.

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

No branches or pull requests

2 participants