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

     1  % umoci(1) # umoci - umoci modifies Open Container images
     2  % Aleksa Sarai
     3  % SEPTEMBER 2018
     4  # NAME
     5  umoci - umoci modifies Open Container images
     6  
     7  # SYNOPSIS
     8  **umoci**
     9  [**--help**|**-h**]
    10  [**--version**|**-v**]
    11  [**--log**={*debug*|*info*|*warn*|*error*|*fatal*}]
    12  [**--verbose**]
    13  *command* [*args*]
    14  
    15  # DESCRIPTION
    16  **umoci** is a tool that allows for high-level modification of an OCI image
    17  layout and its tagged images. While **umoci** attempts to abstract the OCI
    18  image specification specifics, it is recommended that users of this tool read
    19  through [the specification][1] to make sure they understand the rough idea.
    20  
    21  **umoci** is unique in that it is, at the time of writing, the first tool to
    22  allow for arbitrary modification of an OCI image in a high-level fashion (where
    23  all of the different blobs in an OCI image are all managed by **umoci** when
    24  doing a high-level operation such as **umoci-repack**(1)).
    25  
    26  # GLOBAL OPTIONS
    27  
    28  **--help, -h**
    29    Print usage statement.
    30  
    31  **--version, -v**
    32    Print the version.
    33  
    34  **--cpu-profile**=*filename*
    35    Generate a CPU profile during umoci's execution and save it to *filename*.
    36    This file is stored in [Go's pprof][2] format and can be analysed using *go
    37    tool pprof* or similar tools.
    38  
    39  **--log**={*debug*|*info*|*warn*|*error*|*fatal*}
    40    Set the logging level. The default is "warn".
    41  
    42  **--verbose**
    43    Alias for **--log=info**.
    44  
    45  # COMMANDS
    46  
    47  **init**
    48    Create a new OCI layout. See **umoci-init**(1) for more detailed usage
    49    information.
    50  
    51  **new**
    52    Creates a blank tagged OCI image. See **umoci-new**(1) for more detailed
    53    usage information.
    54  
    55  **unpack**
    56    Unpacks a tagged image into an OCI runtime bundle. See **umoci-unpack**(1)
    57    for more detailed usage information.
    58  
    59  **repack**
    60    Repacks an OCI runtime bundle into a tagged image. See **umoci-repack**(1)
    61    for more detailed usage information.
    62  
    63  **config**
    64    Modifies the image configuration of an OCI image. See **umoci-config**(1) for
    65    more detailed usage information.
    66  
    67  **stat**
    68    Displays status information of an image manifest. See **umoci-stat**(1) for
    69    more detailed usage information.
    70  
    71  **tag**
    72    Creates a new tag in an OCI image. See **umoci-tag**(1) for more detailed
    73    usage information.
    74  
    75  **remove, rm**
    76    Removes a tag from an OCI image. See **umoci-remove**(1) for more detailed
    77    usage information.
    78  
    79  **list, ls**
    80    Lists the set of tags in an OCI image. See **umoci-list**(1) for more
    81    detailed usage information.
    82  
    83  **gc**
    84    Garbage collects all unreferenced OCI image blobs. See **umoci-gc**(1) for
    85    more detailed usage information.
    86  
    87  # SEE ALSO
    88  **umoci-init**(1),
    89  **umoci-new**(1),
    90  **umoci-unpack**(1),
    91  **umoci-repack**(1),
    92  **umoci-config**(1),
    93  **umoci-stat**(1),
    94  **umoci-tag**(1),
    95  **umoci-remove**(1),
    96  **umoci-list**(1),
    97  **umoci-gc**(1),
    98  **skopeo**(1)
    99  
   100  [1]: https://github.com/opencontainers/image-spec
   101  [2]: https://golang.org/pkg/runtime/pprof/