Skip to main content

A click based tool for working with remote docker registries

Project description

build-status cover-status pyver-status pypiv-status

This project provides a click based CLI interface against the version 2 docker registry API. I wrote this because Google yielded nothing, and I run a private registry for personal projects that needs maintenance that is extremely cumbersome with curl / bash scripts.

Installation

We’re now available in pypi! Install simply with:

$ pip install drclip

Usage

The tool makes use of the fantastic Click library with a sub command structure:

$ drclip --help

Usage: drclip [OPTIONS] COMMAND [ARGS]...

  Runs commands against docker registries

Options:
  -c, --config FILENAME
  -r, --registry TEXT    The registry to query  [required]
  --help                 Show this message and exit.

Commands:
  digests   Get the digest(s) for given tag(s)
  manifest  List the manifests for a given repository and a given tag
  repos     Lists the repositories in a registry via the _catalog API
  rmd       Removes a manifest(s) for given digest(s)
  tags      Lists the tags for a given repository using the /tags/list API

Tab completion

After installation you can enable tab completion with bash via:

$ eval "$(_DRCLIP_COMPLETE=source drclip)"

Right now only the -r / --registry option supports tab completion.

Environs

There are a couple of environmental variables you can define to avoid tedious argument entry:

  • DRCLIP_REG - defaults the -r / --registry argument on commands

  • DRCLIP_REPO - defaults the -o / --repository argument on commands

Authentication

Credentials for the registries are retrieved (by default) by using the ~/.docker/config.json. Currently only the built in credential store system provided by docker is supported for retrieving credentials.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

drclip-2.0.3.tar.gz (13.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page