oss/syft
2
0
Fork 0
mirror of https://github.com/anchore/syft.git synced 2025-11-17 08:23:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md to use canonical output format names (fixes #2269) (#2272)

Browse Source 
Signed-off-by: Timothy Gerla <tim@gerla.net>
This commit is contained in:
Tim Gerla 2023-10-30 17:25:30 -04:00 committed by GitHub
parent 1aaa644007
commit 262423b1e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -244,16 +244,16 @@ syft <image> -o <format>
``` ```
Where the `formats` available are: Where the `formats` available are:
- `json`: Use this to get as much information out of Syft as possible! - `syft-json`: Use this to get as much information out of Syft as possible!
- `text`: A row-oriented, human-and-machine-friendly output. - `syft-text`: A row-oriented, human-and-machine-friendly output.
- `cyclonedx-xml`: A XML report conforming to the [CycloneDX 1.4 specification](https://cyclonedx.org/specification/overview/). - `cyclonedx-xml`: A XML report conforming to the [CycloneDX 1.4 specification](https://cyclonedx.org/specification/overview/).
- `cyclonedx-json`: A JSON report conforming to the [CycloneDX 1.4 specification](https://cyclonedx.org/specification/overview/). - `cyclonedx-json`: A JSON report conforming to the [CycloneDX 1.4 specification](https://cyclonedx.org/specification/overview/).
- `spdx-tag-value`: A tag-value formatted report conforming to the [SPDX 2.3 specification](https://spdx.github.io/spdx-spec/v2.3/). - `spdx-tag-value`: A tag-value formatted report conforming to the [SPDX 2.3 specification](https://spdx.github.io/spdx-spec/v2.3/).
- `spdx-tag-value@2.2`: A tag-value formatted report conforming to the [SPDX 2.2 specification](https://spdx.github.io/spdx-spec/v2.2.2/). - `spdx-tag-value@2.2`: A tag-value formatted report conforming to the [SPDX 2.2 specification](https://spdx.github.io/spdx-spec/v2.2.2/).
- `spdx-json`: A JSON report conforming to the [SPDX 2.3 JSON Schema](https://github.com/spdx/spdx-spec/blob/v2.3/schemas/spdx-schema.json). - `spdx-json`: A JSON report conforming to the [SPDX 2.3 JSON Schema](https://github.com/spdx/spdx-spec/blob/v2.3/schemas/spdx-schema.json).
- `spdx-json@2.2`: A JSON report conforming to the [SPDX 2.2 JSON Schema](https://github.com/spdx/spdx-spec/blob/v2.2/schemas/spdx-schema.json). - `spdx-json@2.2`: A JSON report conforming to the [SPDX 2.2 JSON Schema](https://github.com/spdx/spdx-spec/blob/v2.2/schemas/spdx-schema.json).
- `github`: A JSON report conforming to GitHub's dependency snapshot format. - `github-json`: A JSON report conforming to GitHub's dependency snapshot format.
- `table`: A columnar summary (default). - `syft-table`: A columnar summary (default).
- `template`: Lets the user specify the output format. See ["Using templates"](#using-templates) below. - `template`: Lets the user specify the output format. See ["Using templates"](#using-templates) below.
## Using templates ## Using templates
@ -266,7 +266,7 @@ Syft lets you define custom output formats, using [Go templates](https://pkg.go.
- Specify the path to the template file (`-t ./path/to/custom.template`). - Specify the path to the template file (`-t ./path/to/custom.template`).
- Syft's template processing uses the same data models as the `json` output format — so if you're wondering what data is available as you author a template, you can use the output from `syft <image> -o json` as a reference. - Syft's template processing uses the same data models as the `syft-json` output format — so if you're wondering what data is available as you author a template, you can use the output from `syft <image> -o syft-json` as a reference.
**Example:** You could make Syft output data in CSV format by writing a Go template that renders CSV data and then running `syft <image> -o template -t ~/path/to/csv.tmpl`. **Example:** You could make Syft output data in CSV format by writing a Go template that renders CSV data and then running `syft <image> -o template -t ~/path/to/csv.tmpl`.
@ -297,7 +297,7 @@ Syft can also output _multiple_ files in differing formats by appending
`=<file>` to the option, for example to output Syft JSON and SPDX JSON: `=<file>` to the option, for example to output Syft JSON and SPDX JSON:
```shell ```shell
syft <image> -o json=sbom.syft.json -o spdx-json=sbom.spdx.json syft <image> -o syft-json=sbom.syft.json -o spdx-json=sbom.spdx.json
``` ```
## Private Registry Authentication ## Private Registry Authentication
@ -454,13 +454,13 @@ Configuration search paths:
Configuration options (example values are the default): Configuration options (example values are the default):
```yaml ```yaml
# the output format(s) of the SBOM report (options: table, text, json, spdx, ...) # the output format(s) of the SBOM report (options: syft-table, syft-text, syft-json, spdx-json, ...)
# same as -o, --output, and SYFT_OUTPUT env var # same as -o, --output, and SYFT_OUTPUT env var
# to specify multiple output files in differing formats, use a list: # to specify multiple output files in differing formats, use a list:
# output: # output:
# - "json=<syft-json-output-file>" # - "syft-json=<syft-json-output-file>"
# - "spdx-json=<spdx-json-output-file>" # - "spdx-json=<spdx-json-output-file>"
output: "table" output: "syft-table"
# suppress all output (except for the SBOM report) # suppress all output (except for the SBOM report)
# same as -q ; SYFT_QUIET env var # same as -q ; SYFT_QUIET env var