{"_id":"github-download","_rev":"20-553ac866e65201eca5ff968e412b1977","name":"github-download","description":"Easily download Github repos without any external dependencies such as Git, Tar, Unzip, etc.","dist-tags":{"latest":"0.5.0"},"versions":{"0.0.1":{"name":"github-download","version":"0.0.1","description":"Easily download Github repos without dependencies such as Git, Tar, Unzip, etc.","homepage":[""],"repository":{"type":"git","url":"git@github.com:jprichardson/node-github-download.git"},"keywords":["github","repository","repo","download","fetch","git"],"author":{"name":"JP Richardson","email":"jprichardson@gmail.com"},"licenses":[{"type":"MIT","url":""}],"dependencies":{"request":"~2.12.0","vcsurl":"~0.1.0"},"devDependencies":{"testutil":"~0.3.0","fs-extra":"~0.3.2","mocha":"*"},"main":"./lib/github-download.js","scripts":{"test":"mocha test"},"_id":"github-download@0.0.1","dist":{"shasum":"7cdf6c6d2e7f3209e9775c368af5efa0066f09b1","tarball":"https://registry.npmjs.org/github-download/-/github-download-0.0.1.tgz","integrity":"sha512-HT4bDKCpWU7GlcGHzl8LyDtDrIii2/24zkqt/mwD8O204Y3ZpDGaPg+FWDT0cmXnDX1Nlq1vTpKHuDTbTjxbxA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFE1aj/Ymeog96ZUoK6GEPpzawPJTHMmhnxwsQrgpxTBAiEAhiKCRAbDZcfECUzCHmmhs4MIG17dDxsHPsc3h9pzBSw="}]},"_npmVersion":"1.1.62","_npmUser":{"name":"jp","email":"jprichardson@gmail.com"},"maintainers":[{"name":"jp","email":"jprichardson@gmail.com"}]},"0.1.0":{"name":"github-download","version":"0.1.0","description":"Easily download Github repos without dependencies such as Git, Tar, Unzip, etc.","homepage":[""],"repository":{"type":"git","url":"git@github.com:jprichardson/node-github-download.git"},"keywords":["github","repository","repo","download","fetch","git"],"author":{"name":"JP Richardson","email":"jprichardson@gmail.com"},"licenses":[{"type":"MIT","url":""}],"dependencies":{"request":"~2.12.0","vcsurl":"~0.1.0","adm-zip":"~0.1.9","fs-extra":"~0.3.2"},"devDependencies":{"testutil":"~0.3.0","mocha":"*","nock":"~0.14.3"},"main":"./lib/github-download.js","scripts":{"test":"mocha test"},"_id":"github-download@0.1.0","dist":{"shasum":"49d0baa4f72e22cbbb694a8e56406a4713863246","tarball":"https://registry.npmjs.org/github-download/-/github-download-0.1.0.tgz","integrity":"sha512-u+NNzj4uaceyaJRAr5AykLi91kBDAVmM6nsPiaTYXMcHikCA3aMIbjg7kGuWKmozUbHgrzqLeALXfegmGAg/2w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBoTAX+bwQ0cC/jzcMF36uz6Mnnsv6o32T8Wg+jgmpYjAiAHMKiIg60uTb9xJnb7RPK+4UPH+Zy7e2k4pT4W16kS8A=="}]},"_npmVersion":"1.1.62","_npmUser":{"name":"jp","email":"jprichardson@gmail.com"},"maintainers":[{"name":"jp","email":"jprichardson@gmail.com"}]},"0.1.1":{"name":"github-download","version":"0.1.1","description":"Easily download Github repos without dependencies such as Git, Tar, Unzip, etc.","homepage":[""],"repository":{"type":"git","url":"git@github.com:jprichardson/node-github-download.git"},"keywords":["github","repository","repo","download","fetch","git"],"author":{"name":"JP Richardson","email":"jprichardson@gmail.com"},"licenses":[{"type":"MIT","url":""}],"dependencies":{"request":"~2.12.0","vcsurl":"~0.1.0","adm-zip":"~0.1.9","fs-extra":"~0.5.0"},"devDependencies":{"testutil":"~0.3.0","mocha":"*","nock":"~0.14.3"},"main":"./lib/github-download.js","scripts":{"test":"mocha test"},"_id":"github-download@0.1.1","dist":{"shasum":"860af35f06a6bb1e1bd49b497bcf0827029e8a4f","tarball":"https://registry.npmjs.org/github-download/-/github-download-0.1.1.tgz","integrity":"sha512-1/felGXCiATd/k61lm+ey1CfS8DqZ3FBeAYk12c8JepQr/yaPPnNYjFbJUN/LtwQCIxCVDzdE5tbJUP16r6VFg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIC1D0U64+3TVzeaG3bn19gXOhvxXDeZDf3W/kgDiSyphAiEA6Am1g7j84HaHrlIFmo6wh0IIt1rgLIadQm0q1oTQ0Fs="}]},"_npmVersion":"1.1.69","_npmUser":{"name":"jp","email":"jprichardson@gmail.com"},"maintainers":[{"name":"jp","email":"jprichardson@gmail.com"}]},"0.2.0":{"name":"github-download","version":"0.2.0","description":"Easily download Github repos without any external dependencies such as Git, Tar, Unzip, etc.","homepage":[""],"repository":{"type":"git","url":"git@github.com:jprichardson/node-github-download.git"},"keywords":["github","repository","repo","download","fetch","git"],"author":{"name":"JP Richardson","email":"jprichardson@gmail.com"},"licenses":[{"type":"MIT","url":""}],"dependencies":{"request":"~2.12.0","vcsurl":"~0.1.0","adm-zip":"~0.4.3","fs-extra":"~0.6.0"},"devDependencies":{"testutil":"~0.5.0","mocha":"*","nock":"~0.14.3"},"main":"./lib/github-download.js","scripts":{"test":"mocha test"},"_id":"github-download@0.2.0","dist":{"shasum":"7508b708bc8f3807ce7dd2d523259bf73816945d","tarball":"https://registry.npmjs.org/github-download/-/github-download-0.2.0.tgz","integrity":"sha512-G3NKCqQXKZ2mjm5ShUtx20mWQv0LF96boVjBda9tFf/8firWOC84Flt8IwPNryXXdypg+HcxkasCVwXU+U96Bg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEM1vlBJi6SUsPIUqzUifpWb2g8tPIY0j8X0bbfO4vdCAiA2ZoHSJsJxI7VOxkyBIZO+EYy17uoUddBAdp1Ccz1msw=="}]},"_from":".","_npmVersion":"1.2.17","_npmUser":{"name":"jp","email":"jprichardson@gmail.com"},"maintainers":[{"name":"jp","email":"jprichardson@gmail.com"}]},"0.3.0":{"name":"github-download","version":"0.3.0","description":"Easily download Github repos without any external dependencies such as Git, Tar, Unzip, etc.","repository":{"type":"git","url":"git@github.com:jprichardson/node-github-download.git"},"keywords":["github","repository","repo","download","fetch","git"],"author":{"name":"JP Richardson","email":"jprichardson@gmail.com"},"licenses":[{"type":"MIT","url":""}],"dependencies":{"request":"~2.12.0","vcsurl":"~0.1.0","adm-zip":"~0.4.3","fs-extra":"^0.9.1"},"devDependencies":{"testutil":"~0.5.0","mocha":"*","nock":"~0.14.3"},"main":"./lib/github-download.js","scripts":{"test":"mocha test"},"bugs":{"url":"https://github.com/jprichardson/node-github-download/issues"},"_id":"github-download@0.3.0","dist":{"shasum":"39f55d754bdedaee51cc4a2fef5852f6043479e0","tarball":"https://registry.npmjs.org/github-download/-/github-download-0.3.0.tgz","integrity":"sha512-J1fBh63y6/q/lO3GnCsiFGhZBG/n/jLY+05B7IMejzFYL2if2uy9yeo+yDdDPwOaqL9grxBxPIIpbuEcKSqHyw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF/xld4hhFzzVX2chA6f7CZNAlrn6Znc/DMM+dc52e+FAiBu43C+MIBQ8vCtgt5caAS/PhjiHxxpUIZ7eKnEE5jbOA=="}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"jp","email":"jprichardson@gmail.com"},"maintainers":[{"name":"jp","email":"jprichardson@gmail.com"}]},"0.4.0":{"name":"github-download","version":"0.4.0","description":"Easily download Github repos without any external dependencies such as Git, Tar, Unzip, etc.","repository":{"type":"git","url":"git+ssh://git@github.com/jprichardson/node-github-download.git"},"keywords":["github","repository","repo","download","fetch","git"],"author":{"name":"JP Richardson","email":"jprichardson@gmail.com"},"license":"MIT","dependencies":{"adm-zip":"~0.4.3","fs-extra":"^0.24.0","request":"~2.12.0","vcsurl":"~0.1.0"},"devDependencies":{"testutil":"~0.5.0","mocha":"*","nock":"~0.14.3"},"main":"./lib/github-download.js","scripts":{"test":"mocha test"},"gitHead":"9827eb7dc2c8ea740e6f4248f68679f799eb2c64","bugs":{"url":"https://github.com/jprichardson/node-github-download/issues"},"homepage":"https://github.com/jprichardson/node-github-download#readme","_id":"github-download@0.4.0","_shasum":"f5ad27c29a59ed83d893064b647ab92fd214a418","_from":".","_npmVersion":"2.10.1","_nodeVersion":"2.1.0","_npmUser":{"name":"jprichardson","email":"jprichardson@gmail.com"},"maintainers":[{"name":"jprichardson","email":"jprichardson@gmail.com"}],"dist":{"shasum":"f5ad27c29a59ed83d893064b647ab92fd214a418","tarball":"https://registry.npmjs.org/github-download/-/github-download-0.4.0.tgz","integrity":"sha512-YiRa5zsPwaXxDwhmi12Kuu/vw2CeZMtOuBMrJeA8isZqeFDaTvBS3dWER1Xvk+tQksyRFvADihbHs+4+fvlI2A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBnjk9oYgGdx9Vnr5/08Cwfc+eeUqT2qXZD0CuemXDatAiEAn0ANrW9417weqAIcK9ICS4aycJcUaJolPhQuSWgHsII="}]}},"0.5.0":{"name":"github-download","version":"0.5.0","description":"Easily download Github repos without any external dependencies such as Git, Tar, Unzip, etc.","repository":{"type":"git","url":"git+ssh://git@github.com/jprichardson/node-github-download.git"},"keywords":["github","repository","repo","download","fetch","git"],"author":{"name":"JP Richardson","email":"jprichardson@gmail.com"},"license":"MIT","dependencies":{"adm-zip":"~0.4.3","fs-extra":"^0.24.0","request":"^2.12.0","vcsurl":"~0.1.0"},"devDependencies":{"testutil":"~0.5.0","mocha":"2.x","nock":"~0.14.3","standard":"5.x"},"main":"./lib/github-download.js","scripts":{"lint":"standard","test":"npm run lint && npm run unit","unit":"mocha test"},"gitHead":"50d431103eb2c517b23668056a2dbaf233a6dfc8","bugs":{"url":"https://github.com/jprichardson/node-github-download/issues"},"homepage":"https://github.com/jprichardson/node-github-download#readme","_id":"github-download@0.5.0","_shasum":"f7647a70aac4326fb091e5786c8f66ae157da51b","_from":".","_npmVersion":"3.5.3","_nodeVersion":"5.3.0","_npmUser":{"name":"jprichardson","email":"jprichardson@gmail.com"},"dist":{"shasum":"f7647a70aac4326fb091e5786c8f66ae157da51b","tarball":"https://registry.npmjs.org/github-download/-/github-download-0.5.0.tgz","integrity":"sha512-ZqNeXWxN8aLttmaX0VBL6cnCGuKT5/pJcRfPlZj9zCu4xOG8USS6XNCMbN7dQpReVbC1xgb4mkc7a4yP91z+ow==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCb3H5SfTJ+++YzHtC2Am7tov9NIlUXyquDE4uvyynfFwIgW8frad10N4+DiP9EMafNQXEAbN83mNmeWN81BkE3CoU="}]},"maintainers":[{"name":"jprichardson","email":"jprichardson@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/github-download-0.5.0.tgz_1462391213642_0.7631614680867642"}}},"readme":"Node.js - github-download\n================\n\n[![build status](https://secure.travis-ci.org/jprichardson/node-github-download.svg)](http://travis-ci.org/jprichardson/node-github-download)\n\nEasily download Github repos without any external dependencies such as Git, Tar, Unzip, etc.\n\n\nWhy?\n----\n\nI really like the concept of managing user defined projects, repos, file structures (package management) on Github like the way that [Component](https://github.com/component) does package management. I have a package management system [Rock](https://github.com/rocktemplates) that I use to create skeleton/templates of projects. I wanted Rock to use Github as a package management system. I also didn't want any dependencies amongst any 3rd party programs like Git, Tar, or Unzip. Pure Node.js JavaScript is what I wanted.\n\n\nInstallation\n------------\n\n npm install github-download\n\n\n\nUsage\n-----\n\n### ghdownload(params, dir)\n\nDownloads the latest copy of some Github reference (branch, tag, or commit), or the `master` branch by default (specifically the `master` branch, it does _not_ honor Github's default branch configuration). This will still work even if the Github API limit has been reached.\n\n- **params**: Can either be:\n - a Github URL string such as:\n - `https://github.com/jprichardson/node-vcsurl.git`\n - `git@github.com:jprichardson/node-vcsurl.git`\n - `git://github.com/jprichardson/node-vcsurl.git`\n - and even including a reference, e.g. `https://github.com/jprichardson/node-vcsurl.git#master`\n - or an object like so: `{user: 'jprichardson', repo: 'vcsurl', ref: 'master'}`\n- **dir**: The output directory. Uses the current working directory if nothing is specified.\n\nReturns a GithubDownloader object that emits events on `dir`, `file`, and `end`.\n\nExample:\n\n```javascript\nvar ghdownload = require('github-download')\n , exec = require('exec')\n\nghdownload({user: 'jprichardson', repo: 'node-batchflow', ref: 'master'}, process.cwd())\n.on('dir', function(dir) {\n console.log(dir)\n})\n.on('file', function(file) {\n console.log(file)\n})\n.on('zip', function(zipUrl) { //only emitted if Github API limit is reached and the zip file is downloaded\n console.log(zipUrl)\n})\n.on('error', function(err) {\n console.error(err)\n})\n.on('end', function() {\n exec('tree', function(err, stdout, sderr) {\n console.log(stdout)\n })\n})\n```\n\nOutputs:\n\n .\n ├── CHANGELOG.md\n ├── LICENSE\n ├── README.md\n ├── lib\n │   └── batchflow.js\n ├── package.json\n └── test\n ├── batchflow-par-array.test.js\n ├── batchflow-par-limit.test.js\n ├── batchflow-par-object.test.js\n ├── batchflow-seq-array.test.js\n ├── batchflow-seq-object.test.js\n ├── batchflow.test.js\n ├── mocha.opts\n └── resources\n\n 3 directories, 12 files\n\n\n\nLicense\n-------\n\n(MIT License)\n\nCopyright 2013-2016, JP Richardson \n","maintainers":[{"name":"jprichardson","email":"jprichardson@gmail.com"}],"time":{"modified":"2022-06-18T12:27:36.736Z","created":"2013-01-17T23:17:44.721Z","0.0.1":"2013-01-17T23:17:45.246Z","0.1.0":"2013-01-21T19:19:38.227Z","0.1.1":"2013-02-03T21:44:08.266Z","0.2.0":"2013-04-29T19:12:43.392Z","0.3.0":"2014-06-17T19:33:38.275Z","0.4.0":"2015-08-30T16:48:44.554Z","0.5.0":"2016-05-04T19:46:55.855Z"},"author":{"name":"JP Richardson","email":"jprichardson@gmail.com"},"repository":{"type":"git","url":"git+ssh://git@github.com/jprichardson/node-github-download.git"},"keywords":["github","repository","repo","download","fetch","git"],"bugs":{"url":"https://github.com/jprichardson/node-github-download/issues"},"readmeFilename":"README.md","homepage":"https://github.com/jprichardson/node-github-download#readme","license":"MIT","users":{"zoxon":true,"binnng":true,"rocket0191":true}}