github.com/chentex/umoci@v0.4.3-0.20180919062622-ef73f30ff150/README.md (about) 1 [][umoci-site] 2 3 [](https://github.com/openSUSE/umoci/releases/latest) 4 [](https://travis-ci.org/openSUSE/umoci) 5  6 7 [](https://goreportcard.com/report/github.com/openSUSE/umoci) 8 [](https://bestpractices.coreinfrastructure.org/projects/1084) 9 [](https://zenodo.org/badge/latestdoi/72283469) 10 11 **u**moci **m**odifies **O**pen **C**ontainer **i**mages. See [the official 12 website][umoci-site] for more accessible documentation about how to use umoci. 13 14 umoci intends to be a complete manipulation tool for [OCI images][oci-image-spec]. 15 In particular, it should be seen as a more end-user-focused version of the 16 [`oci-image-tools` provided by the OCI][oci-image-tools]. The hope is that all 17 of this tooling will eventually be merged with the upstream repository, so that 18 it is always kept up-to-date by the Open Container Initiative community. 19 20 However, currently there is a [lot][disc-1] [of][disc-2] [discussion][disc-3] 21 about the new tooling going into the OCI image tools, and right now I need 22 tooling that can abstract all of the internals of the OCI specification into a 23 single CLI interface. The main purpose of this tool is to serve as example of 24 what **I** would like to see in an `oci-image` tool. 25 26 If you wish to provide feedback or contribute, read the 27 [`CONTRIBUTING.md`][contributing] for this project to refresh your knowledge 28 about how to submit good bug reports and patches. Information about how to 29 submit responsible security disclosures is also provided. 30 31 [umoci-site]: https://umo.ci/ 32 [oci-image-spec]: https://github.com/opencontainers/image-spec 33 [oci-image-tools]: https://github.com/opencontainers/image-tools 34 [disc-1]: https://github.com/opencontainers/image-spec/pull/411 35 [disc-2]: https://github.com/opencontainers/image-tools/pull/5 36 [disc-3]: https://github.com/opencontainers/image-tools/pull/8 37 [contributing]: /CONTRIBUTING.md 38 39 ### Releases ### 40 41 We regularly publish [new releases][releases], with each release being given a 42 unique identifying version number (as governed by [Semantic Versioning 43 (SemVer)][semver]). Information about previous releases including the list of 44 new features, bug fixes and resolved security issues is available in the 45 [change log][changelog]. You can get pre-built binaries and corresponding 46 source code for each release from the [releases page][releases]. 47 48 [semver]: http://semver.org/ 49 [changelog]: /CHANGELOG.md 50 [releases]: https://github.com/openSUSE/umoci/releases 51 52 ### Installation ### 53 54 If you wish to build umoci from source, follow these steps to build in with 55 [golang](https://golang.org). 56 57 ```bash 58 GOPATH=$HOME 59 go get -d github.com/openSUSE/umoci 60 cd $GOPATH/github.com/openSUSE/umoci 61 make install 62 ``` 63 64 Your `umoci` binary will be in `$HOME/bin`. 65 66 ### Usage ### 67 68 umoci has a subcommand-based command-line. For more detailed information, see 69 the generated man pages (which you can build with `make doc`). You can also 70 read through our [quick start guide][quickstart]. 71 72 ``` 73 % umoci --help 74 NAME: 75 umoci - umoci modifies Open Container images 76 77 USAGE: 78 umoci [global options] command [command options] [arguments...] 79 80 VERSION: 81 0.3.1 82 83 AUTHOR(S): 84 Aleksa Sarai <asarai@suse.com> 85 86 COMMANDS: 87 raw advanced internal image tooling 88 help, h Shows a list of commands or help for one command 89 90 image: 91 config modifies the image configuration of an OCI image 92 unpack unpacks a reference into an OCI runtime bundle 93 repack repacks an OCI runtime bundle into a reference 94 new creates a blank tagged OCI image 95 tag creates a new tag in an OCI image 96 remove, rm removes a tag from an OCI image 97 stat displays status information of an image manifest 98 99 layout: 100 gc garbage-collects an OCI image's blobs 101 init create a new OCI layout 102 list, ls lists the set of tags in an OCI image 103 104 GLOBAL OPTIONS: 105 --verbose alias for --log=info 106 --log value set the log level (debug, info, [warn], error, fatal) (default: "warn") 107 --help, -h show help 108 --version, -v print the version 109 ``` 110 111 [quickstart]: https://umo.ci/quick-start/ 112 113 ### License ### 114 115 umoci is licensed under the terms of the Apache 2.0 license. 116 117 ``` 118 umoci: Umoci Modifies Open Containers' Images 119 Copyright (C) 2016, 2017, 2018 SUSE LLC. 120 Copyright (C) 2018 Cisco Systems 121 122 Licensed under the Apache License, Version 2.0 (the "License"); 123 you may not use this file except in compliance with the License. 124 You may obtain a copy of the License at 125 126 http://www.apache.org/licenses/LICENSE-2.0 127 128 Unless required by applicable law or agreed to in writing, software 129 distributed under the License is distributed on an "AS IS" BASIS, 130 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131 See the License for the specific language governing permissions and 132 limitations under the License. 133 ``` 134 135 ### Citation ### 136 137 If you have used umoci in your research, please cite it like you would any 138 other useful software. Here is a handy BibTex citation. 139 140 ``` 141 @misc{umoci, 142 title = {umoci - Standalone Tool For Manipulating Container Images}, 143 author = {Aleksa Sarai et al.}, 144 year = {2016}, 145 url = {https://umo.ci/}, 146 doi = {http://dx.doi.org/10.5281/zenodo.1188474}, 147 } 148 ``` 149 150 Thank you.