Skip to content

Commit bc6eccb

Browse files
committed
Update the README file
Signed-off-by: Sergey "Shnatsel" Davidoff <[email protected]>
1 parent fb63759 commit bc6eccb

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

cargo-cyclonedx/README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,17 @@ This produces a `bom.xml` file adjacent to every `Cargo.toml` file that exists i
3737
-f, --format <FORMAT>
3838
Output BOM format: json, xml
3939
40+
--describe <DESCRIBE>
41+
Possible values:
42+
- crate: Describe the entire crate in a single SBOM file, with Cargo targets as subcomponents. (default)
43+
- binaries: A separate SBOM is emitted for each binary (bin, cdylib) while all other targets are ignored
44+
- all-cargo-targets: A separate SBOM is emitted for each Cargo target, including things that aren't directly executable (e.g rlib)
45+
4046
-v, --verbose...
41-
Use verbose output (-vv very verbose/build.rs output)
47+
Use verbose output (-vv for debug logging, -vvv for tracing)
4248
43-
-q, --quiet
44-
No output printed to stdout
49+
-q, --quiet...
50+
Disable progress reports (-qq to suppress warnings)
4551
4652
--all-features
4753
Activate all available features
@@ -58,29 +64,26 @@ This produces a `bom.xml` file adjacent to every `Cargo.toml` file that exists i
5864
Defaults to the host target, as printed by 'rustc -vV'
5965
6066
--target-in-filename
61-
Include the target platform of the BOM in the filename. Implies --output-cdx
67+
Include the target platform of the BOM in the filename
6268
6369
-a, --all
6470
List all dependencies instead of only top-level ones (default)
6571
6672
--top-level
6773
List only top-level dependencies
6874
69-
--output-cdx
70-
Prepend file extension with .cdx
71-
72-
--output-pattern <PATTERN>
73-
Prefix patterns to use for the filename: bom, package
74-
75-
--output-prefix <FILENAME_PREFIX>
76-
Custom prefix string to use for the filename
75+
--override-filename <FILENAME>
76+
Custom string to use for the output filename
7777
7878
--license-strict
7979
Reject the deprecated '/' separator for licenses, treating 'MIT/Apache-2.0' as an error
8080
8181
--license-accept-named <LICENSE_ACCEPT_NAMED>
8282
Add license names which will not be warned about when parsing them as a SPDX expression fails
8383
84+
--spec-version <SPEC_VERSION>
85+
The CycloneDX specification version to output: `1.3` or `1.4`. Defaults to 1.3
86+
8487
-h, --help
8588
Print help (see a summary with '-h')
8689

0 commit comments

Comments
 (0)