describe artifacts

Usage#

ocm describe artifacts [<options>] {<artifact-reference>}

Options#

  -h, --help            help for artifacts
      --layerfiles      list layer files
  -o, --output string   output mode (JSON, json, yaml)
      --repo string     repository name or spec

Description#

Describe lists all artifact versions specified, if only a repository is specified all tagged artifacts are listed. Per version a detailed, potentially recursive description is printed.

If the repository/registry option is specified, the given names are interpreted relative to the specified registry using the syntax

<OCI repository name>[:<tag>][@<digest>]

If no –repo option is specified the given names are interpreted as extended OCI artifact references.

[<repo type>::]<host>[:<port>]/<OCI repository name>[:<tag>][@<digest>]

The –repo option takes a repository/OCI registry specification:

[<repo type>::]<configured name>|<file path>|<spec json>

For the Common Transport Format the types directory, tar or tgz are possible.

Using the JSON variant any repository types supported by the linked library can be used:

• ArtifactSet: v1
• CommonTransportFormat: v1
• DockerDaemon: v1
• Empty: v1
• OCIRegistry: v1
• oci: v1
• ociRegistry

With the option –output the output mode can be selected. The following modes are supported:

• (default)
• JSON
• json
• yaml

Examples#

$ ocm describe artifact ghcr.io/open-component-model/ocm/component-descriptors/ocm.software/ocmcli:0.17.0
$ ocm describe artifact ghcr.io/open-component-model/ocm/ocm.software/ocmcli/ocmcli-image:0.17.0

See Also#

• ocm describe — Describe various elements by using appropriate sub commands.