Skip to content

Commit

Permalink
adding syft documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nmaguiar authored Dec 23, 2024
1 parent 7b7818b commit f871848
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
12 changes: 12 additions & 0 deletions EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ List of examples:
| Kubernetes | Loop the cpu, memory and storage metrics of each container on the current Kubernetes node |
| Images | Checking images content |
| Images | Checkout the files per layer on an existing image |
| Images | Generate a BOM (Bill Of Materials) for a provided image |

> To search for a specific example type '/Checking images content<ENTER>' and use the arrow keys to navigate
Expand Down Expand Up @@ -410,3 +411,14 @@ oafp libs=dockerregistry in=registryrepos data={} inregistrytags=true out=csv in

> You can check more options by executing 'oafp libs=dockerregistry help=dockerregistry'
---

## Generate a BOM (Bill Of Materials) for a provided image

You can use the _syft_ tool to generate a CycloneDX JSON BOM (Bill Of Materials) file:

```bash
syft scan nmaguiar/imgutils -o cyclonedx-json
```

---
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Alpine based image ("nmaguiar/imgutils") with:
* crictl
* ctr
* nerdctl
* syft
* dive (https://github.com/wagoodman/dive rebuilt using https://github.com/jauderho/dive)
* openaf (with DockerRegistry, Kube, oafp)
* mc (Midnight Commander)
Expand Down

0 comments on commit f871848

Please sign in to comment.