Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/regclient/regclient
Docker and OCI Registry Client in Go and tooling using those libraries.
https://github.com/regclient/regclient
docker hacktoberfest registry
Last synced: 5 days ago
JSON representation
Docker and OCI Registry Client in Go and tooling using those libraries.
- Host: GitHub
- URL: https://github.com/regclient/regclient
- Owner: regclient
- License: apache-2.0
- Created: 2020-09-09T17:22:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-29T15:42:33.000Z (14 days ago)
- Last Synced: 2024-12-31T15:04:36.996Z (12 days ago)
- Topics: docker, hacktoberfest, registry
- Language: Go
- Homepage:
- Size: 5.05 MB
- Stars: 1,352
- Watchers: 10
- Forks: 97
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-repositories - regclient/regclient - Docker and OCI Registry Client in Go and tooling using those libraries. (Go)
README
# regclient
[](https://github.com/regclient/regclient/actions/workflows/go.yml)
[](https://github.com/regclient/regclient/actions/workflows/docker.yml)
[](https://github.com/regclient/regclient/actions/workflows/version-check.yml)
[](https://github.com/regclient/regclient/actions/workflows/vulnscans.yml)
[](https://pkg.go.dev/github.com/regclient/regclient)
[](https://goreportcard.com/report/github.com/regclient/regclient)
[](https://github.com/regclient/regclient/releases)
Client interface for the registry API.
This includes `regctl` for a command line interface to manage registries.
## regclient Features
- Provides a client interface to interacting with registries.
- Images may be inspected without pulling the layers, allowing quick access to the image manifest and configuration.
- Tags may be listed for a repository.
- Repositories may be listed from a registry (if supported).
- Copying an image only pulls layers when needed, allowing images to be quickly retagged or promoted across repositories.
- Multi-platform images are supported, allowing all platforms to be copied between registries.
- Digest tags used by projects like sigstore/cosign are supported, allowing signature, attestation, and SBOM metadata to be copied with the image.
- OCI subject/referrers is supported for the standardized replacement of the "digest tags".
- Digests may be queried for a tag without pulling the manifest.
- Rate limits may be queried from the registry without pulling an image (useful for Docker Hub).
- Images may be imported and exported to both OCI and Docker formatted tar files.
- OCI Layout is supported for copying images to and from a local directory.
- Delete APIs have been provided for tags, manifests, and blobs (the tag deletion will only delete a single tag even if multiple tags point to the same digest).
- Registry logins are imported from docker when available
- Self signed, insecure, and http-only registries are all supported.
- Requests will retry and fall back to chunked uploads when network issues are encountered.
## regctl Features
`regctl` is a CLI interface to the `regclient` library.
In addition to the features listed for `regclient`, `regctl` adds the following abilities:
- Formatting output with templates.
- Push and pull arbitrary artifacts.
## regsync features
`regsync` is an image mirroring tool.
It will copy images between two locations with the following additional features:
- Uses a yaml configuration.
- The `regclient` copy is used to only pull needed layers, supporting multi-platform, and additional metadata.
- Can use user's docker configuration for registry credentials.
- Ability to run on a cron schedule, one time synchronization, or only check for stale images.
- Ability to backup previous target image before overwriting.
- Ability to postpone mirror step when rate limit is below a threshold.
- Ability to mirror multiple images concurrently.
## regbot features
`regbot` is a scripting tool on top of the `regclient` API with the following features:
- Runs user provided scripts based on a yaml configuration.
- Scripts are written in Lua and executed directly in Go.
- Can run on a cron schedule or a one time execution.
- Dry-run option can be used for testing.
- Built-in functions include:
- Repository list
- Tag list
- Image manifest (either head or get, and optional resolving multi-platform reference)
- Image config (this includes the creation time, labels, and other details shown in a `docker image inspect`)
- Image rate limit and a wait function to delay the script when rate limit remaining is below a threshold
- Image copy
- Manifest delete
- Tag delete
## Development Status
This project is in active development.
Various Go APIs may change, but efforts will be made to provide aliases and stubs for any removed API.
## Installing
See the [installation options](docs/install.md).
## Usage
See the [project documentation](docs/README.md).
## Contributors
