Skip to content

Commit c9eb708

Browse files
docs: unify command name to cyclonedx
1 parent 5de8d19 commit c9eb708

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Binaries can be downloaded from the [releases page](https://github.com/CycloneDX
4141
Note: The CycloneDX CLI tool is built for automation use cases. Any commands that have the `--input-file` option also support feeding input from stdin. Likewise, any commands that have the `--output-file` option support output to stdout. However, you will need to supply the input/output formats.
4242

4343
For example:
44-
`cat bom.json | cyclonedx-cli convert --input-format json --output-format xml > bom.xml`
44+
`cat bom.json | cyclonedx convert --input-format json --output-format xml > bom.xml`
4545

4646
# Commands
4747

@@ -70,10 +70,10 @@ Options:
7070
#### Examples
7171

7272
Generating a source code BOM, excluding Git repository directory:
73-
`cyclonedx-cli add files --no-input --output-format json --exclude /.git/**`
73+
`cyclonedx add files --no-input --output-format json --exclude /.git/**`
7474

7575
Adding build output files, from `bin` directory, to existing BOM:
76-
`cyclonedx-cli add files --input-file bom.json --output-format json --base-path bin`
76+
`cyclonedx add files --input-file bom.json --output-format json --base-path bin`
7777

7878
## Analyze Command
7979

@@ -94,7 +94,7 @@ Options:
9494
### Examples
9595

9696
Reporting on components that are included multiple times with different versions:
97-
`cyclonedx-cli analyze --input-file sbom.xml --multiple-component-versions`
97+
`cyclonedx analyze --input-file sbom.xml --multiple-component-versions`
9898

9999
## Convert Command
100100

@@ -116,10 +116,10 @@ Options:
116116
### Examples
117117

118118
Converting from XML to JSON format:
119-
`cyclonedx-cli convert --input-file sbom.xml --output-file sbom.json`
119+
`cyclonedx convert --input-file sbom.xml --output-file sbom.json`
120120

121121
Converting from XML to JSON format and piping output to additional tools:
122-
`cyclonedx-cli convert --input-file sbom.xml --output-format json | grep "somthing"`
122+
`cyclonedx convert --input-file sbom.xml --output-format json | grep "somthing"`
123123

124124
### CSV Format
125125

@@ -166,7 +166,7 @@ Options:
166166
### Examples
167167

168168
Reporting on components with version changes:
169-
`cyclonedx-cli diff sbom-from.xml sbom-to.xml --component-versions`
169+
`cyclonedx diff sbom-from.xml sbom-to.xml --component-versions`
170170

171171
## Keygen Command
172172

@@ -208,10 +208,10 @@ described in the metadata component element.
208208
### Examples
209209

210210
Merge two XML formatted BOMs:
211-
`cyclonedx-cli merge --input-files sbom1.xml sbom2.xml --output-file sbom_all.xml`
211+
`cyclonedx merge --input-files sbom1.xml sbom2.xml --output-file sbom_all.xml`
212212

213213
Merging two BOMs and piping output to additional tools:
214-
`cyclonedx-cli merge --input-files sbom1.xml sbom2.xml --output-format json | grep "something"`
214+
`cyclonedx merge --input-files sbom1.xml sbom2.xml --output-format json | grep "something"`
215215

216216
## Sign Command
217217

@@ -269,7 +269,7 @@ Options:
269269
### Examples
270270

271271
Validate BOM and return non-zero exit code (handy for automatically "breaking" a build, etc)
272-
`cyclonedx-cli validate --input-file sbom.xml --fail-on-errors`
272+
`cyclonedx validate --input-file sbom.xml --fail-on-errors`
273273

274274
## Verify Command
275275

0 commit comments

Comments
 (0)