---
name: "umoci-config"
section: "1"
platform: "linux"
package: "umoci"
version: "0.6.0-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/umoci-config"
---

# umoci-config(1)

Modifies the configuration of an OCI image

Aleksa Sarai DECEMBER 2016

## NAME

umoci config - Modifies the configuration of an OCI image

## SYNOPSIS

**umoci config** **--image**=*image*\[:*tag*\] \[**--tag**=*new-tag*\] \[**--no-history**\] \[**--history.comment**=*comment*\] \[**--history.created\_by**=*created\_by*\] \[**--history.author**=*author*\] \[**--history-created**=*date*\] \[**--clear**=*value*\] \[**--config.user**=*value*\] \[**--config.exposedports**=*value*\] \[**--config.env**=*value*\] \[**--config.entrypoint**=*value*\] \[**--config.cmd**=*value*\] \[**--config.volume**=*value*\] \[**--config.label**=*value*\] \[**--config.workingdir**=*value*\] \[**--created**=*value*\] \[**--author**=*value*\] \[**--platform.os**=*value*\] \[**--platform.arch**=*value*\] \[**--manifest.annotation**=*value*\]

## DESCRIPTION

Modify the configuration and manifest data for a particular tagged OCI image -- **overwriting it unless you specify --tag**. If **--no-history** was not specified, a history entry is appended to the tagged OCI image for this change (with the various **--history.** flags controlling the values used). To view the history, see [**umoci-stat**(1)](/umoci-stat/1.md).

Note that the original image tag (the argument to **--image**) will **not** be modified unless the target of [**umoci-config**(1)](/umoci-config/1.md) is the original image tag.

## OPTIONS

The global options are defined in [**umoci**(1)](/umoci/1.md).

**--image**=*image*\[:*tag*\]\
   The source tagged OCI image whose config will be modified. *image* must be\
   a path to a valid OCI image and *tag* must be a valid tag in the image. If\
   *tag* is not provided it defaults to "latest".

**--tag**=*new-tag*\
   Tag name for the modified image, if unspecified then the original tag\
   provided to **--image** will be clobbered.

**--no-history**\
   Causes no history entry to be added for this operation.

**--history.comment**=*comment*\
   Comment for the history entry corresponding to this modification of the image\
   configuration. If unspecified, [**umoci**(1)](/umoci/1.md) will generate an\
   implementation-dependent value.

**--history.created\_by**=*created\_by*\
   CreatedBy entry for the history entry corresponding to this modification of\
   the image configuration. If unspecified, [**umoci**(1)](/umoci/1.md) will generate an\
   implementation-dependent value.

**--history.author**=*author*\
   Author value for the history entry corresponding to this modification of the\
   image configuration. If unspecified, this value will be the image's author\
   value **after** any modifications were made by this call of\
   [**umoci-config**(1)](/umoci-config/1.md).

**--history-created**=*date*\
   Creation date for the history entry corresponding to this modifications of\
   the image configuration. This must be an ISO8601 formatted timestamp (see\
   [**date**(1)](/date/1.md)). If unspecified, the current time is used.

**--clear**=*value*\
   Removes all pre-existing entries for a given set or list configuration option\
   (it will not undo any modification made by this call of [**umoci-config**(1)](/umoci-config/1.md)).\
   The valid values of *value* are:

```
* config.labels
* manifest.annotations
* config.exposedports
* config.env
* config.entrypoint
* config.cmd
* config.volume
```

The following commands all set their corresponding values in the configuration or image manifest. For more information see the OCI image specification ⟨https://github.com/opencontainers/image-spec⟩.

- •

  **--config.user**=*value*

- •

  **--config.exposedports**=*value*

- •

  **--config.env**=*value*

- •

  **--config.entrypoint**=*value*

- •

  **--config.cmd**=*value*

- •

  **--config.volume**=*value*

- •

  **--config.label**=*value*

- •

  **--config.workingdir**=*value*

- •

  **--created**=*value*

- •

  **--author**=*value*

- •

  **--platform.os**=*value* (can also be set with **--os**)

- •

  **--platform.arch**=*value* (can also be set with **--architecture**)

- •

  **--manifest.annotation**=*value*

## EXAMPLE

The following modifies an OCI image configuration in various ways, and overwrites the original tag with the new image.

```
% umoci config --image image:tag --clear=config.env --config.env="VARIABLE=true" \
	--config.user="user:group" --config.entrypoint=cat --config.cmd=/proc/self/stat \
	--config.label="com.cyphar.umoci=true" --author="Aleksa Sarai <cyphar@cyphar.com>" \
	--platform.os="linux" --platform.arch="amd64" --created="$(date --iso-8601=seconds)"
```

## SEE ALSO

[**umoci**(1)](/umoci/1.md)