Formatting and filtering the Container Registry CLI output

You can format and filter the IBM Cloud® Container Registry CLI output for supported IBM Cloud Container Registry commands.

By default, the CLI output is displayed in a human-readable format. However, this view might limit your ability to use the output, particularly if the command is run programmatically. For example, in the ibmcloud cr image-list CLI output you might want to sort the Size field in numerical order, but the command returns a string description. The container-registry CLI plug-in provides the format option that you can use to apply a Go template to the CLI output. The Go template is a feature of the Go programming language that you can use to customize the CLI output.

You can alter the CLI output by applying the format option in two different ways:

• Format data in your CLI output. For example, change the Created field output from UNIX® time to standard time.
• Filter data in your CLI output. For example, filter by details of the image to display a specific subset of images by using the Go template if gt condition.

You can use the format option with the following IBM Cloud Container Registry commands. Click a command to view a list of available fields and their data types.

• ibmcloud cr image-digests command
• ibmcloud cr image-list command
• ibmcloud cr image-inspect command

The following code examples demonstrate how you might use the formatting and filtering options.

• Run the following ibmcloud cr image-digests command to display all untagged images referenced by their digests.

  ibmcloud cr image-digests --format '{{if not .Tags}}{{.Repository}}@{{.Digest}}{{end}}'
  

  The following message is an example of the output from the command

  example-<region>.icr.io/user1/my_first_repo@<digest1>
  example-<region>.icr.io/user1/my_first_repo@<digest2>
  example-<region>.icr.io/user1/my_first_repo@<digest3>
  

• Run the following ibmcloud cr image-list command to display repository, tag, and security status of all tagged images that have a size over 1 MB.

  ibmcloud cr image-list --format "{{ if gt .Size 1000000 }}{{ .Repository }}:{{ .Tag }} {{ .SecurityStatus.Status }}{{end}}"
  

  The following message is an example of the output from the command:

  example-<region>.icr.io/user1/my_first_repo:latest No Issues
  example-<region>.icr.io/user1/my_second_repo:1 2 Issues
  example-<region>.icr.io/user1/my_second_repo:test1 1 Issue
  example-<region>.icr.io/user1/my_second_repo_2:test2 7 Issues
  

  If the listing images command times out, see Why is it timing out when I list images? for assistance.

• Run the following ibmcloud cr image-inspect command to display where IBM Documentation is hosted for a specified IBM public image.

  ibmcloud cr image-inspect ibm_public_image --format "{{ .ContainerConfig.Labels }}"
  

  The following message is an example of the output from the command:

  map[doc.url:/docs/images/docker_image_ibm_public_image/ibm_public_image_starter.html]
  

• Run the following ibmcloud cr image-inspect command to display the exposed ports for a specified image.

  ibmcloud cr image-inspect ibm_public_image --format "{{ .Config.ExposedPorts }}"
  

  The following message is an example of the output from the command:

  map[9080/tcp: 9443/tcp:]