You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
--project-name Dependency track project name. Default use the directory name
38
-
--project-version Dependency track project version [string] [default: ""]
39
-
--project-id Dependency track project id. Either provide the id or the project name and version together [string]
40
-
--parent-project-id Dependency track parent project id [string]
41
-
--required-only Include only the packages with required scope on the SBOM. Would set compositions.aggregate to incomplete unless --no-auto-compositions is passed. [boolean]
42
-
--fail-on-error Fail if any dependency extractor fails. [boolean]
43
-
--no-babel Do not use babel to perform usage analysis for JavaScript/TypeScript projects. [boolean]
44
-
--generate-key-and-sign Generate an RSA public/private key pair and then sign the generated SBOM using JSON Web Signatures. [boolean]
--install-deps Install dependencies automatically for some projects. Defaults to true but disabled for containers and oci scans. Use --no-install-deps to disable this feature. [boolean] [default: true]
49
-
--validate Validate the generated SBOM using json schema. Defaults to true. Pass --no-validate to disable. [boolean] [default: true]
50
-
--evidence Generate SBOM with evidence for supported languages. [boolean] [default: false]
51
-
--spec-version CycloneDX Specification version to use. Defaults to 1.6 [number] [choices: 1.4, 1.5, 1.6] [default: 1.6]
52
-
--filter Filter components containing this word in purl or component.properties.value. Multiple values allowed. [array]
53
-
--only Include components only containing this word in purl. Useful to generate BOM with first party components alone. Multiple values allowed. [array]
54
-
--author The person(s) who created the BOM. Set this value if you're intending the modify the BOM and claim authorship. [array] [default: "OWASP Foundation"]
55
-
--profile BOM profile to use for generation. Default generic. [choices: "appsec", "research", "operational", "threat-modeling", "license-compliance", "generic", "machine-learning", "ml", "deep-learning", "ml-deep", "ml-tiny"] [default: "generic"]
56
-
--exclude Additional glob pattern(s) to ignore [array]
57
-
--include-formulation Generate formulation section with git metadata and build tools. Defaults to false. [boolean] [default: false]
58
-
--include-crypto Include crypto libraries as components. [boolean] [default: false]
59
-
--standard The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to. [array] [choices: "asvs-5.0", "asvs-4.0.3", "bsimm-v13", "masvs-2.0.0", "nist_ssdf-1.1", "pcissc-secure-slc-1.1", "scvs-1.0.0", "ssaf-DRAFT-2023-11"]
60
-
--json-pretty Pretty-print the generated BOM json. [boolean] [default: false]
61
-
--min-confidence Minimum confidence needed for the identity of a component from 0 - 1, where 1 is 100% confidence. [number] [default: 0]
62
-
--technique Analysis technique to use [array] [choices: "auto", "source-code-analysis", "binary-analysis", "manifest-analysis", "hash-comparison", "instrumentation", "filename"]
63
-
--auto-compositions Automatically set compositions when the BOM was filtered. Defaults to true [boolean] [default: true]
--project-name Dependency track project name. Default use the directory name
38
+
--project-version Dependency track project version [string] [default: ""]
39
+
--project-id Dependency track project id. Either provide the id or the project name and version together [string]
40
+
--parent-project-id Dependency track parent project id [string]
41
+
--required-only Include only the packages with required scope on the SBOM. Would set compositions.aggregate to incomplete unless --no-auto-compositions is passed. [boolean]
42
+
--fail-on-error Fail if any dependency extractor fails. [boolean]
43
+
--no-babel Do not use babel to perform usage analysis for JavaScript/TypeScript projects. [boolean]
44
+
--generate-key-and-sign Generate an RSA public/private key pair and then sign the generated SBOM using JSON Web Signatures. [boolean]
--install-deps Install dependencies automatically for some projects. Defaults to true but disabled for containers and oci scans. Use --no-install-deps to disable this feature. [boolean] [default: true]
49
+
--validate Validate the generated SBOM using json schema. Defaults to true. Pass --no-validate to disable. [boolean] [default: true]
50
+
--evidence Generate SBOM with evidence for supported languages. [boolean] [default: false]
51
+
--spec-version CycloneDX Specification version to use. Defaults to 1.6 [number] [choices: 1.4, 1.5, 1.6, 1.7] [default: 1.6]
52
+
--filter Filter components containing this word in purl or component.properties.value. Multiple values allowed. [array]
53
+
--only Include components only containing this word in purl. Useful to generate BOM with first party components alone. Multiple values allowed. [array]
54
+
--author The person(s) who created the BOM. Set this value if you're intending the modify the BOM and claim authorship. [array] [default: "OWASP Foundation"]
55
+
--profile BOM profile to use for generation. Default generic. [choices: "appsec", "research", "operational", "threat-modeling", "license-compliance", "generic", "machine-learning", "ml", "deep-learning", "ml-deep", "ml-tiny"] [default: "generic"]
56
+
--exclude Additional glob pattern(s) to ignore [array]
57
+
--include-formulation Generate formulation section with git metadata and build tools. Defaults to false. [boolean] [default: false]
58
+
--include-crypto Include crypto libraries as components. [boolean] [default: false]
59
+
--standard The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to. [array] [choices: "asvs-5.0", "asvs-4.0.3", "bsimm-v13", "masvs-2.0.0", "nist_ssdf-1.1", "pcissc-secure-slc-1.1", "scvs-1.0.0", "ssaf-DRAFT-2023-11"]
60
+
--json-pretty Pretty-print the generated BOM json. [boolean] [default: false]
61
+
--min-confidence Minimum confidence needed for the identity of a component from 0 - 1, where 1 is 100% confidence. [number] [default: 0]
62
+
--technique Analysis technique to use [array] [choices: "auto", "source-code-analysis", "binary-analysis", "manifest-analysis", "hash-comparison", "instrumentation", "filename"]
63
+
--auto-compositions Automatically set compositions when the BOM was filtered. Defaults to true [boolean] [default: true]
64
+
-h, --help Show help [boolean]
65
+
-v, --version Show version number [boolean]
66
66
67
-
Examples:
68
-
cdxgen -t java . Generate a Java SBOM for the current directory
69
-
cdxgen -t java -t js . Generate a SBOM for Java and JavaScript in the current directory
70
-
cdxgen -t java --profile ml . Generate a Java SBOM for machine learning purposes.
71
-
cdxgen -t python --profile research . Generate a Python SBOM for appsec research.
72
-
cdxgen --server Run cdxgen as a server
67
+
Examples:
68
+
cdxgen -t java . Generate a Java SBOM for the current directory
69
+
cdxgen -t java -t js . Generate a SBOM for Java and JavaScript in the current directory
70
+
cdxgen -t java --profile ml . Generate a Java SBOM for machine learning purposes.
71
+
cdxgen -t python --profile research . Generate a Python SBOM for appsec research.
72
+
cdxgen --server Run cdxgen as a server
73
73
74
-
for documentation, visit https://cyclonedx.github.io/cdxgen"
75
-
`,
74
+
for documentation, visit https://cyclonedx.github.io/cdxgen"
0 commit comments