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.

Sign up for GitHub

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

Jump to bottom

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

Open
suzuki-shunsuke opened this issue Dec 29, 2022 · 1 comment · May be fixed by #298
Open

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

suzuki-shunsuke opened this issue Dec 29, 2022 · 1 comment · May be fixed by #298

Comments

@suzuki-shunsuke
Copy link

Hi, I have a feedback.

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

cyclonedx-cli/README.md

Lines 56 to 57 in 5de8d19

Usage:
cyclonedx add files [options]

cyclonedx-cli/README.md

Line 73 in 5de8d19

`cyclonedx-cli add files --no-input --output-format json --exclude /.git/**`

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 suzuki-shunsuke mentioned this issue Dec 29, 2022
Merged
@suzuki-shunsuke
Copy link
Author

Created a pull request to solve this issue.

@suzuki-shunsuke suzuki-shunsuke linked a pull request Dec 29, 2022 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: unify command name to cyclonedx suzuki-shunsuke/cyclonedx-cli
1 participant
@suzuki-shunsuke