Skip to content

dubo-dubon-duponey/regander

Repository files navigation

Regander

A piece of shcript to interact with them Dockeristries

Build Status FOSSA Status

regander is a full-fledged client for the Docker Registry API aiming at completeness and correctness.

In a shell: it takes care of the dreaded token authentication and all the HTTP monkeying for you, allowing the consumer to easily implement higher-level scripts to manipulate images, by using simple method calls that closely mimic the API.

regander also provides extensive debugging and logging options that are useful to troubleshoot misbehaving registries and images, including curl stances that can be copy-pasted to manually replay HTTP calls, and uses exit codes to convey meaningful errors.

reghigh uses regander to implement higher level concept (downloading, uploading, or cloning an entire multi-architecture image, for example).

Installation

The easy-way

on mac

brew install dubo-dubon-duponey/brews/regander

The other way

linux and mac

You need bash (the real bash, version 3 or above - you have that, right?)

And jq (on mac brew install jq).

Then git clone https://github.com/dubo-dubon-duponey/regander --recursive.

Then make build inside the clone.

Now you have ./bin/regander and ./bin/reghigh

Windows

meh

meh

Usage TL;DR

[ENV=FOO] regander [flags] endpoint METHOD [object] [reference]

For example:

regander -s --registry=https://myregistry manifest HEAD library/nginx alpine

Moar?

regander --help

The user will be prompted for credentials in interactive mode. Otherwise regander will fallback to anonymous queries, or use whatever credentials are provided through the environment.

You can also check the reference for extensive usage details in a single page.

Reghigh

[TODO]

Caveats and TODO

See the todo.

Develop

See the develop doc.

License

FOSSA Status