mirror of
https://github.com/anchore/syft
synced 2024-09-20 14:11:54 +00:00
16 lines
673 B
Markdown
16 lines
673 B
Markdown
|
# Syft API Examples
|
||
|
|
|
||
|
|
This directory contains examples of how to use the Syft API.
|
||
|
|
|
||
|
|
- `create_simple_sbom`: Create a simple SBOM from scratch
|
||
|
|
- `create_custom_sbom`: Create an SBOM using as much custom configuration as possible, including a custom cataloger implementation
|
||
|
|
- `decode_sbom`: Take an existing SBOM file (of arbitrary format) and decode it into a Syft SBOM object
|
||
|
|
- `source_detection`: Shows how to detect what to catalog automatically from a user string (e.g. container image vs directory)
|
||
|
|
- `source_from_image`: Construct a source from a only a container image
|
||
|
|
|
||
|
|
You can run any of these examples from this directory with:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
go run ./DIRECTORY_NAME
|
||
|
|
```
|