Skip to content

docs: document aibom cli enrich flag #1535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sburuiana-snyk wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: document aibom cli enrich flag #1535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
052f95e
docs: document aibom cli enrich flag
sburuiana-snyk Jul 23, 2026
f68f6fd
docs: update cli release date
sburuiana-snyk Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions developer-tools/snyk-cli/cli-commands-and-options-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ Lists of the options for Snyk CLI commands follow. Each option is followed by th

## `snyk aibom` command options

`--enriched`: When enabled, runs additional slower enrichment steps on the AI-BOM\
`--html`\
`--json-file-output`: [snyk aibom](commands/aibom.md)

Expand Down
6 changes: 6 additions & 0 deletions developer-tools/snyk-cli/commands/aibom-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ This generates an AI-BOM for the current directory, runs the policy test for the

Example: `$ snyk aibom test --json-file-output=results.json`

### `--enriched`

**Optional**. When enabled, runs additional slower enrichment steps on the AI-BOM before the policy test.

Example: `$ snyk aibom test --enriched`

### `--severity-threshold=<low|medium|high|critical>`

**Optional**. Minimum severity that triggers `action_needed` (exit code 1). Only issues at or above this level cause the command to exit with 1. Default: `low`.
9 changes: 9 additions & 0 deletions developer-tools/snyk-cli/commands/aibom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,15 @@ Default: `<ORG_ID>` that is the current preferred Organization in your [Account

**Optional**. Persist the AIBOM into your Snyk Organization. This flag requires the [`--repo`](aibom.md#repo) flag. It enables you to view your AI-BOM for the repository in the Evo web interface.

### `--enriched`

**Optional**. When enabled, runs additional slower enrichment steps on the AI-BOM.

```bash
snyk aibom --enriched
snyk aibom --enriched --upload --repo https://github.com/[owner]/[repo]
```

### `--repo`

**Optional**. Specify the repository to use when persisting the AI-BOM. Required when you use the [`--upload`](aibom.md#upload) flag.
Expand Down
6 changes: 6 additions & 0 deletions discover-snyk/whats-new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ description: Recent updates to Snyk products and documentation, including new fe

The most recent updates include significant changes to the user docs, such as features added or removed, structural changes that affect how you find relevant information, and other improvements to enhance your interaction with the Snyk knowledge base.

## August 2026

### Snyk CLI

* AI-BOM enrichment from the CLI: the `snyk aibom` and `snyk aibom test` commands document the new `--enriched` option. When enabled, it runs additional slower enrichment steps on the AI-BOM. Visit [snyk aibom](https://docs.snyk.io/developer-tools/snyk-cli/commands/aibom) and [snyk aibom test](https://docs.snyk.io/developer-tools/snyk-cli/commands/aibom-test) for more details.

## June 2026

### Snyk CLI
Expand Down
Loading