update documentation to reflect root vs packages subcommand

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
2 changed files with 6 additions and 4 deletions
+5 -3
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:
```
syft packages <image>
# note: this is the same as not providing the "packages" subcommand
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).
To include software from all image layers in the SBOM, regardless of its presence in the final image, provide `--scope all-layers`: