oss/syft
2
0
Fork 0
mirror of https://github.com/anchore/syft.git synced 2026-02-12 10:36:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

update documentation to reflect root vs packages subcommand

Browse Source 
Signed-off-by: Alex Goodman <alex.goodman@anchore.com>
This commit is contained in:
Alex Goodman 2021-03-23 13:00:25 -04:00
parent 929b78efbf
commit 68c4bf8bbe
No known key found for this signature in database
GPG Key ID: 5CB45AE22BAB7EA7
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -78,7 +78,7 @@ all: clean static-analysis test ## Run all linux-based checks (linting, license
@printf '$(SUCCESS)All checks pass!$(RESET)\n' @printf '$(SUCCESS)All checks pass!$(RESET)\n'
.PHONY: test .PHONY: test
test: unit validate-cyclonedx-schema integration benchmark acceptance-linux cli ## Run all tests (currently unit, integration, linux acceptance, and mac cli tests) test: unit validate-cyclonedx-schema integration benchmark acceptance-linux cli ## Run all tests (currently unit, integration, linux acceptance, and cli tests)
.PHONY: help .PHONY: help
help: help:

8
README.md
View File

@ -21,12 +21,14 @@ If you encounter an issue, please [let us know using the issue tracker](https://
To generate an SBOM for a Docker or OCI image: To generate an SBOM for a Docker or OCI image:
``` ```
syft packages <image>
# note: this is the same as not providing the "packages" subcommand
syft <image> syft <image>
``` ```
**Note**: This is equivalent to specifying the `packages` subcommand:
```
syft packages <image>
```
The above output includes only software that is visible in the container (i.e., the squashed representation of the image). The above output includes only software that is visible in the container (i.e., the squashed representation of the image).
To include software from all image layers in the SBOM, regardless of its presence in the final image, provide `--scope all-layers`: To include software from all image layers in the SBOM, regardless of its presence in the final image, provide `--scope all-layers`: