umoci(1)(#)

πŸ“¦
version 0.6.0 Β· 4 versions
, in arch rolling, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu stonking

πŸ’– umoci(1) β€” the it-girl of OCI image surgery πŸ’…

okay bestie, pull up a chair, we're talking about umoci, and she's from the umoci manual, section 1. written by Aleksa Sarai, way back in SEPTEMBER 2018 (a vintage, honestly). let's get into it ✨


🌸 NAME 🌸

umoci β€” umoci modifies Open Container images. that's it, that's the whole vibe. she modifies. she does not merely look. πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

umoci [--help|-h] [--version|-v] [--log={debug|info|warn|error|fatal}]
[--verbose] command [args]

so you run umoci, you sprinkle some global flags, you name a command, you hand it some args. simple. clean. iconic. πŸ’–


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so here's the tea β˜• β€” umoci is a tool that lets you do high-level modification of an OCI image layout and its tagged images. she tries to abstract away all the fiddly specifics of the OCI image specification, but β€” and this is important, bestie β€” it is recommended that users of this tool actually read through the specification at https://github.com/opencontainers/image-spec so you understand the rough idea. like, she'll hold your hand, but you should still know where you're walking, yk? 🫢

and here's why she's special: umoci is unique in that she is, at the time of writing, the first tool to allow for arbitrary modification of an OCI image in a high-level fashion β€” meaning all the different blobs in an OCI image are all managed by umoci when you do a high-level operation, like umoci-repack(1). the blobs? handled. the chaos? contained. she's giving main character energy fr fr. πŸ‘‘


✨ GLOBAL OPTIONS ✨

  • --help, -h β€” prints the usage statement. your lil "what do i do" button πŸ’…
  • --version, -v β€” prints the version. say hi to her ✨
  • --cpu-profile=filename β€” generates a CPU profile while umoci is running and saves it to filename. this file is stored in Go's pprof format (https://golang.org/pkg/runtime/pprof/) and can be analysed using go tool pprof or similar tools. nerd stuff, but the good kind 🧚
  • --log={debug|info|warn|error|fatal} β€” sets the logging level. the default is "warn". pick your volume, bestie πŸ”Š
  • --verbose β€” alias for --log=info. the shortcut for the girlies in a hurry πŸ’¨

πŸ‘‘ COMMANDS πŸ‘‘

  • init β€” creates a new OCI layout. see umoci-init(1) for more detailed usage information. baby's first layout 🍼
  • new β€” creates a blank tagged OCI image. see umoci-new(1) for more detailed usage information. a fresh canvas, a clean slate 🌈
  • unpack β€” unpacks a tagged image into an OCI runtime bundle. see umoci-unpack(1) for more detailed usage information. open the box, see what's inside πŸ“¦
  • repack β€” repacks an OCI runtime bundle into a tagged image. see umoci-repack(1) for more detailed usage information. put it all back, but cuter πŸ’–
  • config β€” modifies the image configuration of an OCI image. see umoci-config(1) for more detailed usage information. glow-up time ✨
  • stat β€” displays status information of an image manifest. see umoci-stat(1) for more detailed usage information. she's nosy in the best way πŸ”
  • tag β€” creates a new tag in an OCI image. see umoci-tag(1) for more detailed usage information. label her, name her, make her yours 🏷️
  • remove, rm β€” removes a tag from an OCI image. see umoci-remove(1) for more detailed usage information. it's not a loss, it's a declutter 🧹
  • list, ls β€” lists the set of tags in an OCI image. see umoci-list(1) for more detailed usage information. show me everyone πŸ’…
  • gc β€” garbage collects all unreferenced OCI image blobs. see umoci-gc(1) for more detailed usage information. take out the trash, no cap πŸ—‘οΈ

πŸ’œ SEE ALSO πŸ’œ

umoci-init(1), umoci-new(1), umoci-unpack(1), umoci-repack(1), umoci-config(1), umoci-stat(1), umoci-tag(1), umoci-remove(1), umoci-list(1), umoci-gc(1), skopeo(1)


one more thing bestie β€” the whole umoci family links out to each other's man pages, so if you're ever lost, SEE ALSO is literally right there holding your hand 🫢

okay that's the whole page, mwah πŸ’‹ this was umoci(1) (section 1, the umoci manual β€” you found her in the right place), written by Aleksa Sarai, dated SEPTEMBER 2018. drink water, read your specs, and go modify some images. slay πŸŽ€βœ¨πŸ‘‘

πŸ“¦ where this page comes from