Giter Club home page Giter Club logo

docker-pull's Introduction

docker-pull

Pull a docker image from a registry using node

npm install docker-pull

Usage

var pull = require('docker-pull')

pull('ubuntu', function (err) {
  console.log('was pulled?', !err)
})

var p = pull('ubuntu:14.04')

p.on('progress', function () {
  console.log('pulled %d new layers and %d/%d bytes', p.layers, p.transferred, p.length)
})

p.on('end', function () {
  console.log('pull is done')
})

Api

var p = pull(image, [options], [callback]])

Pull a docker image. Returns an EventEmitter. Optionally you can specify the following options:

{
  host:     'registry.example.com', // docker registry
  version:  'v2',                   // defaults to 'v1.15'
  username: 'user',                 // defaults to 'anon'
  password: 'pwd',                  // defaults to ''
  email:    '[email protected]'      // no default
}

p.on('progress', progress)

Emitted for each data chunk.

p.on('end', function () {})

Emitted when the operation has ended.

p.on('error', err)

Emitted when an error happens during communication with the registry.

Command line tool

There is also a command line tool

npm install -g docker-pull
docker-pull ubuntu:14.04

License

MIT

docker-pull's People

Contributors

mafintosh avatar ralphtheninja avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.