examples/

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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:

go run ./DIRECTORY_NAME