docker-browse

1.1.0 • Public • Published

build-status

docker-browse

CLI tool to browse docker registries via Docker Registry HTTP API V2

Requires node 8+.

Installation

npm install -g docker-browse

Usage

  Usage: docker-browse <command> [options]
 
 
  Options:
 
    -V, --version              output the version number
    -r, --registry <registry>  registry to query (index.docker.io)
    -p, --protocol <protocol>  http|https (https)
    -h, --help                 output usage information
 
 
  Commands:
 
    images        output images, paginated
    tags <image>  output tags for <image>
    save          save current options as defaults in ~/.docker-browse.json

e.g. list all tags for an image from the default registry:

docker-browse tags library/openjdk

e.g. list all tags from an image from a specified registry

docker-browse tags mycool/image -r my.local.registry

e.g. list all images from the default registry (will take a LONG time and you might not have access):

docker-browse images

e.g. change your default registry:

docker-browse -r my.local.registry save

Authentication and Authorisation

Anonymous registries will be directly queried.

Registries that require authentication and authorisaion will read ~/.docker/config.json for your credentials. See Docker Registry v2 authentication via central service for more details.

If credentials cannot be found, you will be prompted to create them e.g.

FATAL:  cannot find auth for index.docker.io in auths in /somehome/someuser/.docker/config.json
ACTION: docker login index.docker.io

Developing

Clone

git clone git@bitbucket.org:atlassianlabs/docker-browse.git
cd docker-browse

system node/npm

Install

npm install

Execute bin/docker-browse.js from the repository root.

nvm provided node/npm

nvm possibly useful for dev.

Select node/npm version

nvm use

Install

npm install

Link For Development

npm link

You may now execute docker-browse from anywhere within your nvm managed shell.

Releasing

npm version 3.2.1
npm publish
git push
git push --tags

Contributing

Pull requests, issues and comments welcome. For pull requests:

  • Separate unrelated changes into multiple pull requests
  • branch build must be successful

See the existing issues for things to start contributing.

For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change.

License

Copyright (c) 2017 Atlassian and others. Apache 2.0 licensed, see LICENSE file.

Dependencies (6)

Dev Dependencies (7)

Package Sidebar

Install

npm i docker-browse

Weekly Downloads

1,745

Version

1.1.0

License

Apache-2.0

Last publish

Collaborators

  • acourtis