search

CycloneDX / cyclonedx-cli

CycloneDX CLI tool for SBOM analysis, merging, diffs and format conversions.
https://cyclonedx.org/
Apache License 2.0
312 stars 61 forks source link

CLI name is ambiguous, because both `cyclonedx-cli` and `cyclonedx` are used in document #297

Open suzuki-shunsuke opened 1 year ago

suzuki-shunsuke commented 1 year ago

Hi, I have a feedback.

I think the CLI name is ambiguous, because both cyclonedx-cli and cyclonedx are used in README.

https://github.com/CycloneDX/cyclonedx-cli/blob/5de8d19b2b678da8a04bd6dba38cdae26ef4347f/README.md?plain=1#L56-L57

https://github.com/CycloneDX/cyclonedx-cli/blob/5de8d19b2b678da8a04bd6dba38cdae26ef4347f/README.md?plain=1#L73

So how about unifying the command name either cyclonedx-cli and cyclonedx in the document?

When we install the CLI with Homebrew, the command name is not cyclonedx-cli but cyclonedx, so maybe cyclonedx is preferred.

suzuki-shunsuke commented 1 year ago

Created a pull request to solve this issue.