Skip to content

Commit

Permalink
refine Spec
Browse files Browse the repository at this point in the history
  • Loading branch information
FeynmanZhou authored May 9, 2024
1 parent 1f0d525 commit 6ca5db4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/proposals/formatted-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The formatted output is not intended to supersede the prettified human-readable

ORAS allows to use `--output` to output a file or directory in the filesystem. To enable users to format the metadata output of ORAS commands and compute figures based on the formatted output, these two options are proposed as follows:

- Use `--format json|tree|table|go-template=GO_TEMPLATE` to format metadata output of ORAS commands into different formats including prettified JSON, tree, table view, and Go template. It supports computing figures within the template using [Sprig](http://masterminds.github.io/sprig/) functions. This is the primary and recommended usage.
- Use `--format <DATA_FORMAT>` to format metadata output of ORAS commands into different formats including prettified JSON, tree, table view, and Go template, i.e. `--format json|tree|table|go-template=GO_TEMPLATE`. It supports computing figures within the template using [Sprig](http://masterminds.github.io/sprig/) functions. This is the primary and recommended usage.
- Use `--template GO_TEMPLATE` to compute and manipulate the output data using Go template based on the chosen data format. To avoid ambiguous, this flag can only be used along with `--format <DATA_FORMAT>`.

## Feature status
Expand Down

0 comments on commit 6ca5db4

Please sign in to comment.