Download a github repository to a folder using the .tar.gz bundle
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
test
.gitignore
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

Build Status Dependency Status

GetHub

Download a github repository to a folder using the .tar.gz bundle

Installation

$ npm install gethub

Usage

Command Line

The following command downloads gethub at the master tag into the gethub folder

$ gethub ForbesLindesay/gethub

API

var join = require('path').join;
var download = require('gethub');

download('ForbesLindesay', 'gethub', 'master', join(__dirname, 'gethub'), function (err) {
  if (err) throw err;
  console.log('downloaded ForbesLindesay/gethub@master into: ' + join(__dirname, 'gethub'));
});

Promise API

If you omit the callback, a promise is returned.

var join = require('path').join;
var download = require('gethub');

download('ForbesLindesay', 'gethub', 'master', join(__dirname, 'gethub'))
  .then(function (err) {
    console.log('downloaded into: ' + join(__dirname, 'gethub'));
  }, function (err) {
    console.warn(err.stack);
  });

License

MIT