.nh
.TH umoci(1) # umoci - umoci modifies Open Container images
Aleksa Sarai
SEPTEMBER 2018

.SH NAME
.PP
umoci - umoci modifies Open Container images


.SH SYNOPSIS
.PP
\fBumoci\fP
[\fB--help\fP|\fB-h\fP]
[\fB--version\fP|\fB-v\fP]
[\fB--log\fP={\fIdebug\fP|\fIinfo\fP|\fIwarn\fP|\fIerror\fP|\fIfatal\fP}]
[\fB--verbose\fP]
\fIcommand\fP [\fIargs\fP]


.SH DESCRIPTION
.PP
\fBumoci\fP is a tool that allows for high-level modification of an OCI image
layout and its tagged images. While \fBumoci\fP attempts to abstract the OCI
image specification specifics, it is recommended that users of this tool read
through the specification
\[la]https://github.com/opencontainers/image-spec\[ra] to make sure they understand the rough idea.

.PP
\fBumoci\fP is unique in that it is, at the time of writing, the first tool to
allow for arbitrary modification of an OCI image in a high-level fashion (where
all of the different blobs in an OCI image are all managed by \fBumoci\fP when
doing a high-level operation such as \fBumoci-repack\fP(1)).


.SH GLOBAL OPTIONS
.PP
\fB--help, -h\fP
  Print usage statement.

.PP
\fB--version, -v\fP
  Print the version.

.PP
\fB--cpu-profile\fP=\fIfilename\fP
  Generate a CPU profile during umoci's execution and save it to \fIfilename\fP\&.
  This file is stored in Go's pprof
\[la]https://golang.org/pkg/runtime/pprof/\[ra] format and can be analysed using \fIgo
  tool pprof\fP or similar tools.

.PP
\fB--log\fP={\fIdebug\fP|\fIinfo\fP|\fIwarn\fP|\fIerror\fP|\fIfatal\fP}
  Set the logging level. The default is "warn".

.PP
\fB--verbose\fP
  Alias for \fB--log=info\fP\&.


.SH COMMANDS
.PP
\fBinit\fP
  Create a new OCI layout. See \fBumoci-init\fP(1) for more detailed usage
  information.

.PP
\fBnew\fP
  Creates a blank tagged OCI image. See \fBumoci-new\fP(1) for more detailed
  usage information.

.PP
\fBunpack\fP
  Unpacks a tagged image into an OCI runtime bundle. See \fBumoci-unpack\fP(1)
  for more detailed usage information.

.PP
\fBrepack\fP
  Repacks an OCI runtime bundle into a tagged image. See \fBumoci-repack\fP(1)
  for more detailed usage information.

.PP
\fBconfig\fP
  Modifies the image configuration of an OCI image. See \fBumoci-config\fP(1) for
  more detailed usage information.

.PP
\fBstat\fP
  Displays status information of an image manifest. See \fBumoci-stat\fP(1) for
  more detailed usage information.

.PP
\fBtag\fP
  Creates a new tag in an OCI image. See \fBumoci-tag\fP(1) for more detailed
  usage information.

.PP
\fBremove, rm\fP
  Removes a tag from an OCI image. See \fBumoci-remove\fP(1) for more detailed
  usage information.

.PP
\fBlist, ls\fP
  Lists the set of tags in an OCI image. See \fBumoci-list\fP(1) for more
  detailed usage information.

.PP
\fBgc\fP
  Garbage collects all unreferenced OCI image blobs. See \fBumoci-gc\fP(1) for
  more detailed usage information.


.SH SEE ALSO
.PP
\fBumoci-init\fP(1),
\fBumoci-new\fP(1),
\fBumoci-unpack\fP(1),
\fBumoci-repack\fP(1),
\fBumoci-config\fP(1),
\fBumoci-stat\fP(1),
\fBumoci-tag\fP(1),
\fBumoci-remove\fP(1),
\fBumoci-list\fP(1),
\fBumoci-gc\fP(1),
\fBskopeo\fP(1)