@@ -41,7 +41,7 @@ Binaries can be downloaded from the [releases page](https://github.com/CycloneDX
41
41
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.
42
42
43
43
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 `
45
45
46
46
# Commands
47
47
@@ -70,10 +70,10 @@ Options:
70
70
#### Examples
71
71
72
72
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/** `
74
74
75
75
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 `
77
77
78
78
## Analyze Command
79
79
@@ -94,7 +94,7 @@ Options:
94
94
### Examples
95
95
96
96
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 `
98
98
99
99
## Convert Command
100
100
@@ -116,10 +116,10 @@ Options:
116
116
### Examples
117
117
118
118
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 `
120
120
121
121
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" `
123
123
124
124
### CSV Format
125
125
@@ -166,7 +166,7 @@ Options:
166
166
### Examples
167
167
168
168
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 `
170
170
171
171
## Keygen Command
172
172
@@ -208,10 +208,10 @@ described in the metadata component element.
208
208
### Examples
209
209
210
210
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 `
212
212
213
213
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" `
215
215
216
216
## Sign Command
217
217
@@ -269,7 +269,7 @@ Options:
269
269
### Examples
270
270
271
271
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 `
273
273
274
274
## Verify Command
275
275
0 commit comments