github.com/opencontainers/umoci@v0.4.8-0.20240508124516-656e4836fb0d/doc/man/umoci-stat.1.md (about)

     1  % umoci-stat(1) # umoci stat - Display status information about an image tag
     2  % Aleksa Sarai
     3  % SEPTEMBER 2018
     4  # NAME
     5  umoci stat - Display status information about an image tag
     6  
     7  # SYNOPSIS
     8  **umoci stat**
     9  **--image**=*image*[:*tag*]
    10  [**--json**]
    11  
    12  # DESCRIPTION
    13  Generates various pieces of status information about an image tag, including
    14  the history of the image.
    15  
    16  **WARNING**: Do not depend on the output of this tool. Previously we
    17  recommended the use of **--json** as the "stable" interface but this interface
    18  will be reworked in future.
    19  
    20  # OPTIONS
    21  The global options are defined in **umoci**(1).
    22  
    23  **--image**=*image*[:*tag*]
    24    The OCI image tag to display information about. *image* must be a path to a
    25    valid OCI image and *tag* must be a valid tag in the image. If *tag* is not
    26    provided it defaults to "latest".
    27  
    28  **--json**
    29    Output the status information as a JSON encoded blob.
    30  
    31  # FORMAT
    32  The format of the **--json** blob is as follows. Many of these fields come from
    33  the [OCI image specification][1].
    34  
    35      {
    36        # This is the set of history entries for the image.
    37        "history": [
    38          {
    39            "layer":       <descriptor>, # null if empty_layer is true
    40            "diff_id":     <diffid>,
    41            "created":     <created>,
    42            "created_by":  <created_by>,
    43            "author":      <author>,
    44            "empty_layer": <empty_layer>
    45          }...
    46        ]
    47      }
    48  
    49  In future versions of **umoci**(1) there may be extra fields added to the above
    50  structure. However, the currently defined fields will always be set (until a
    51  backwards-incompatible release is made).
    52  
    53  # EXAMPLE
    54  
    55  The following gets information about an image downloaded from a **docker**(1)
    56  registry using **skopeo**(1).
    57  
    58  ```
    59  % skopeo copy docker://opensuse/amd64:42.2 oci:image:latest
    60  % umoci stat --image image
    61  LAYER                                                                   CREATED                        CREATED BY                                                                                        SIZE     COMMENT
    62  <none>                                                                  2016-12-05T22:52:33.085510751Z /bin/sh -c #(nop)  MAINTAINER SUSE Containers Team <containers@suse.com>                          <none>
    63  sha256:e800e72a0a88984bd1b47f4eca1c188d3d333dc8e799bfa0a02ea5c2697216d5 2016-12-05T22:52:46.570617134Z /bin/sh -c #(nop) ADD file:6e0044405547c4c209fac622b3c6ddc75e7370682197f7920ec66e4e5e00b180 in /  49.25 MB
    64  ```
    65  
    66  # SEE ALSO
    67  **umoci**(1)
    68  
    69  [1]: https://github.com/opencontainers/image-spec