diff --git a/docs/sbom-tool-arguments.md b/docs/sbom-tool-arguments.md index 1032554b..e44d88f4 100644 --- a/docs/sbom-tool-arguments.md +++ b/docs/sbom-tool-arguments.md @@ -28,6 +28,7 @@ Actions ValidateSignature (-s) If set, will validate the manifest using the signed catalog file. IgnoreMissing (-im) If set, will not fail validation on the files presented in Manifest but missing on the disk. + FailIfNoPackages (-n) If set to true, validation will fail if there are no packages detected in the sbom. RootPathFilter (-r) If you're downloading only a part of the drop using the '-r' or 'root' parameter in the drop client, specify the same string value here in order to skip validating paths that are not downloaded. @@ -86,6 +87,8 @@ DeleteManifestDirIfPresent (-D) If set to true, we will delete any pre already present in the ManifestDirPath without asking the user for confirmation. The new manifest directory will then be created at this location and the generated SBOM will be stored there. +FetchLicenseInformation (-li) If set to true, we will attempt to fetch license information of packages + detected in the SBOM from the ClearlyDefinedApi. Verbosity (-V) Display this amount of detail in the logging output. Verbose Debug @@ -101,4 +104,4 @@ FollowSymlinks (-F) If set to false, we will not follow sy ManifestInfo (-mi) A list of the name and version of the manifest format that we are using. -``` \ No newline at end of file +``` diff --git a/docs/sbom-tool-cli-reference.md b/docs/sbom-tool-cli-reference.md index 7a2462ed..310103e3 100644 --- a/docs/sbom-tool-cli-reference.md +++ b/docs/sbom-tool-cli-reference.md @@ -92,6 +92,15 @@ In order to scan a path to populate the files section of the SBOM, the user can ./sbom-tool-win-x64.exe generate -b c:\outputDrop -m c:\outputPath -pn TestProject -pv 1.0.0 -ps MyCompany -nsb http://mycompany.com -di testImage:0.0.1 ``` +### Excluding Directories from Component Scan + +You can exclude directories from the component scan by specifying the `-cd` parameter you can pass arguments directly to Component Detection. One of these arguments is `--DirectoryExclusionList` Filters out specific directories following a minimatch pattern from the component scan which will leave +the contents of these directories out of the packages section of the SBOM. For example, if you wanted to exclude the `bin` directory from the component scan you would run the following command + +``` +./sbom-tool-win-x64.exe generate -b c:\outputDrop -bc c:\Users\test\TestProject -pn TestProject -pv 1.0.0 -ps MyCompany -nsb http://mycompany.com -cd "--DirectoryExclusionList **/bin/**" +``` + ### Write telemetry to a file By default, users commonly log telemetry to the console output. In order to log the telemetry as part of the SBOM file, specify the `-t` parameter: