{"id":13903244,"url":"https://github.com/opencontainers/image-tools","last_synced_at":"2025-05-16T12:10:28.215Z","repository":{"id":37269992,"uuid":"67737264","full_name":"opencontainers/image-tools","owner":"opencontainers","description":"OCI Image Tooling","archived":false,"fork":false,"pushed_at":"2023-03-09T19:05:20.000Z","size":2486,"stargazers_count":276,"open_issues_count":61,"forks_count":84,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-04-12T08:38:06.834Z","etag":null,"topics":["containers","docker","oci"],"latest_commit_sha":null,"homepage":"https://opencontainers.org","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opencontainers.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-09-08T20:19:15.000Z","updated_at":"2025-03-17T07:50:19.000Z","dependencies_parsed_at":"2022-09-26T17:50:43.258Z","dependency_job_id":"bf814abe-f3b0-42eb-960c-837bf53a5c79","html_url":"https://github.com/opencontainers/image-tools","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencontainers%2Fimage-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencontainers%2Fimage-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencontainers%2Fimage-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencontainers%2Fimage-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opencontainers","download_url":"https://codeload.github.com/opencontainers/image-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254527100,"owners_count":22085919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["containers","docker","oci"],"created_at":"2024-08-06T22:01:54.395Z","updated_at":"2025-05-16T12:10:28.152Z","avatar_url":"https://github.com/opencontainers.png","language":"Go","funding_links":[],"categories":["docker"],"sub_categories":[],"readme":"# oci-image-tool [![Build Status](https://travis-ci.org/opencontainers/image-tools.svg?branch=master)](https://travis-ci.org/opencontainers/image-tools)[![Go Report Card](https://goreportcard.com/badge/github.com/opencontainers/image-tools)](https://goreportcard.com/report/github.com/opencontainers/image-tools)\n\n`oci-image-tool` is a collection of tools for working with the [OCI image format specification](https://github.com/opencontainers/image-spec).\nTo build from source code, image-tools requires Go 1.7.x or above.\n\n## Project Status\n\n**This project is no longer actively maintained, and has had major deficiencies\nfor several years. This project may be archived in the future, depending on\ncommunity feedback.**\n\nThe `oci-image-tools` repository has two classes of tools, and our\nrecommendation is different based on which tools you need:\n\n* Conformance testing tools (`oci-image-tool validate`). Currently there is no\n  replacement for this functionality in a different OCI project, so users\n  should continue to use this tool -- but should be aware that it is unlikely\n  to be updated to future versions of the OCI Image Specification.\n\n* Image manipulation tools (`oci-image-tool create` and `oci-image-tool\n  validate`). These tools have had many long-standing correctness and\n  functionality issues (see [1][p1], [2][p2], [3][p3], [4][p4], [5][p5],\n  [6][p6], [7][p7], [8][p8], [9][p9], [10][p10]), and we have not recommended\n  their use for a fairly long time. Users should instead use [umoci][umoci] for\n  these tasks, which is a production-grade reference implementation of the OCI\n  Image Specification that is actively maintained and does not suffer from the\n  same deficiencies as this project.\n\n[umoci]: https://github.com/opencontainers/umoci\n[p1]: https://github.com/opencontainers/image-tools/issues/17\n[p2]: https://github.com/opencontainers/image-tools/pull/8\n[p3]: https://github.com/opencontainers/image-tools/issues/59\n[p4]: https://github.com/opencontainers/image-tools/issues/74\n[p5]: https://github.com/opencontainers/image-tools/issues/76\n[p6]: https://github.com/opencontainers/image-tools/issues/193\n[p7]: https://github.com/opencontainers/image-tools/issues/218\n[p8]: https://github.com/opencontainers/image-tools/issues/219\n[p9]: https://github.com/opencontainers/image-tools/issues/223\n[p10]: https://github.com/opencontainers/image-tools/issues/188\n\n\n## Install\n\nIt is recommended that use `go get` to download a single command tools.\n\n```\n$ go get -d github.com/opencontainers/image-tools/cmd/oci-image-tool\n$ cd $GOPATH/src/github.com/opencontainers/image-tools/\n$ make all\n$ sudo make install\n```\n\n## Uninstall\n\n```\n$ sudo make uninstall\n```\n\n## Example\n\n### Obtaining an image\n\nThe following examples assume you have a [image-layout](https://github.com/opencontainers/image-spec/blob/v1.0.0-rc2/image-layout.md) tar archive at `busybox-oci`.\nOne way to acquire that image is with [skopeo](https://github.com/projectatomic/skopeo#installing):\n\n```\n$ skopeo copy docker://busybox oci:busybox-oci:latest\n```\n\n### oci-image-tool-create\n\nMore information about `oci-image-tool-create` can be found in its [man page](./man/oci-image-tool-create.1.md)\n\n```\n$ mkdir busybox-bundle\n$ oci-image-tool create --ref latest busybox-oci busybox-bundle\n$ cd busybox-bundle \u0026\u0026 sudo runc run busybox\n```\n\n### oci-image-tool-validate\n\nMore information about `oci-image-tool-validate` can be found in its [man page](./man/oci-image-tool-validate.1.md)\n\n```\n$ oci-image-tool validate --type imageLayout --ref latest busybox-oci\nbusybox-oci: OK\n```\n\n### oci-image-tool-unpack\n\nMore information about `oci-image-tool-unpack` can be found in its [man page](./man/oci-image-tool-unpack.1.md)\n\n```\n$ mkdir busybox-bundle\n$ oci-image-tool unpack --ref latest busybox-oci busybox-bundle\n$ tree busybox-bundle\nbusybox-bundle\n├── bin\n│   ├── [\n│   ├── [[\n│   ├── acpid\n│   ├── addgroup\n│   ├── add-shell\n[...]\n```\n\n# Contributing\n\nDevelopment happens on GitHub. Issues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).\n\nThe code is licensed under the Apache 2.0 license found in the `LICENSE` file of this repository.\n\n## Code of Conduct\n\nParticipation in the OpenContainers community is governed by [OpenContainer's Code of Conduct](https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md).\n\n## Discuss your design\n\nThe project welcomes submissions, but please let everyone know what you are working on.\n\nBefore undertaking a nontrivial change to this repository, send mail to the [mailing list](#mailing-list) to discuss what you plan to do.\nThis gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits.\nIt also guarantees that the design is sound before code is written; a GitHub pull-request is not the place for high-level discussions.\n\nTypos and grammatical errors can go straight to a pull-request.\nWhen in doubt, start on the [mailing-list](#mailing-list).\n\n## Weekly Call\n\nThe contributors and maintainers of all OCI projects have a weekly meeting Wednesdays at 2:00 PM (USA Pacific.)\nEveryone is welcome to participate via [UberConference web][UberConference] or audio-only: 888-587-9088 or 860-706-8529 (no PIN needed.)\nAn initial agenda will be posted to the [mailing list](#mailing-list) earlier in the week, and everyone is welcome to propose additional topics or suggest other agenda alterations there.\nMinutes are posted to the [mailing list](#mailing-list) and minutes from past calls are archived to the [wiki](https://github.com/opencontainers/runtime-spec/wiki) for those who are unable to join the call.\n\n## Mailing List\n\nYou can subscribe and join the mailing list on [Google Groups](https://groups.google.com/a/opencontainers.org/forum/#!forum/dev).\n\n## IRC\n\nOCI discussion happens on #opencontainers on Freenode ([logs][irc-logs]).\n\n## Git commit\n\n### Sign your work\n\nThe sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.\nThe rules are pretty simple: if you can certify the below (from [developercertificate.org](http://developercertificate.org/)):\n\n```\nDeveloper Certificate of Origin\nVersion 1.1\n\nCopyright (C) 2004, 2006 The Linux Foundation and its contributors.\n660 York Street, Suite 102,\nSan Francisco, CA 94110 USA\n\nEveryone is permitted to copy and distribute verbatim copies of this\nlicense document, but changing it is not allowed.\n\n\nDeveloper's Certificate of Origin 1.1\n\nBy making a contribution to this project, I certify that:\n\n(a) The contribution was created in whole or in part by me and I\n    have the right to submit it under the open source license\n    indicated in the file; or\n\n(b) The contribution is based upon previous work that, to the best\n    of my knowledge, is covered under an appropriate open source\n    license and I have the right under that license to submit that\n    work with modifications, whether created in whole or in part\n    by me, under the same open source license (unless I am\n    permitted to submit under a different license), as indicated\n    in the file; or\n\n(c) The contribution was provided directly to me by some other\n    person who certified (a), (b) or (c) and I have not modified\n    it.\n\n(d) I understand and agree that this project and the contribution\n    are public and that a record of the contribution (including all\n    personal information I submit with it, including my sign-off) is\n    maintained indefinitely and may be redistributed consistent with\n    this project or the open source license(s) involved.\n```\n\nthen you just add a line to every git commit message:\n\n    Signed-off-by: Joe Smith \u003cjoe@gmail.com\u003e\n\nusing your real name (sorry, no pseudonyms or anonymous contributions.)\n\nYou can add the sign off when creating the git commit via `git commit -s`.\n\n### Commit Style\n\nSimple house-keeping for clean git history.\nRead more on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) or the Discussion section of [`git-commit(1)`](http://git-scm.com/docs/git-commit).\n\n1. Separate the subject from body with a blank line\n2. Limit the subject line to 50 characters\n3. Capitalize the subject line\n4. Do not end the subject line with a period\n5. Use the imperative mood in the subject line\n6. Wrap the body at 72 characters\n7. Use the body to explain what and why vs. how\n  * If there was important/useful/essential conversation or information, copy or include a reference\n8. When possible, one keyword to scope the change in the subject (i.e. \"README: ...\", \"runtime: ...\")\n\n\n[UberConference]: https://www.uberconference.com/opencontainers\n[irc-logs]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencontainers%2Fimage-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopencontainers%2Fimage-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencontainers%2Fimage-tools/lists"}