# keryn sca image

Describes Keryn 0.5.2 and keryn-rules 0.8.0.

> keryn sca image: OSV-Scanner execution, SCA report intake with completion receipts, complete-package inventory, offline advisory assessment, Deno inventory, SBOM-to-files comparison

Source: https://keryn.dev/docs/reference/cli/sca-image/

> **Caution: Next release: keryn sca image**
> On main; not in Keryn 0.5.2, the latest release.

OSV-Scanner execution, SCA report intake with completion receipts, complete-package inventory, offline advisory assessment, Deno inventory, SBOM-to-files comparison.

```text
keryn sca image <oci-layout|docker-archive.tar|registry/repository[:tag|@sha256:digest]> --out <new-directory> [--pull [--platform <os/arch>] [--pull-redirects]] [--advisories <OSV-record-array.json> | --online] [--fail-on error|warning|info|none]
```

## Options

```text
keryn sca image <oci-layout|docker-archive.tar> --out <new-directory> [--advisories <OSV-record-array.json> | --online] [--fail-on error|warning|info|none] [--json]
keryn sca image <registry/repository[:tag|@sha256:digest]> --pull [--platform os/arch] [--pull-redirects] --out <new-directory> [...]
No daemon and no image execution. Nothing is fetched without --pull: it reads the manifest and layers over HTTPS from the registry you name (and the token
endpoint it advertises), checks every blob against its digest, and records the manifest digest. Credentials: KERYN_REGISTRY_USERNAME and
KERYN_REGISTRY_PASSWORD, or KERYN_REGISTRY_TOKEN. --pull-redirects also follows a layer download the registry redirects to its storage host.
Offline inventory is unknown without an advisory snapshot.
```

## Examples

```sh
# Assess installed packages using a local advisory snapshot.
keryn sca image image.tar --out out/image --advisories osv.json

# Read the pushed image from its registry, with no daemon, and check it against OSV.dev.
keryn sca image registry.example.com/team/app@sha256:6f1c0f3b8a4d2e5c9b7a1d0e3f2c4b5a6978d0e1f2a3b4c5d6e7f8091a2b3c4d --pull --platform linux/amd64 --out out/image --online
```

## Exit codes

| Code | Meaning |
|---|---|
| 0 | pass |
| 1 | findings or a requested change gate |
| 2 | usage error or invalid input |
| 3 | incomplete or unknown completion |
| 4 | execution or normalization failure |

## Environment

| Variable | Meaning | Default |
|---|---|---|
| `GITHUB_TOKEN` | Token for keryn decide export --github. There is no flag for it. | unset |
| `GITLAB_TOKEN` | Token for keryn decide export --gitlab. There is no flag for it. | unset |
