transfer-github

Transfer GitHub

GitHub repository downloader for Node.js.

Why?

Because I needed a simple way to download the contents of a GitHub repository using Node.js.

Features

Transfer GitHub is pretty simple. It doesn't iterate over a list of repositories and it doesn't clone the repositories. What it does is to receive a single repository string — in the username/repository#branch format — and download its contents to a destination directory.

Example

var github = require("transfer-github");

github.get("username/repository#branch", "/destination/directory", function(error) {

	if (error) {
		console.error(error);
	}

});

Installation

npm install --save transfer-github

A.P.I.

get(repository, destination, callback)

Downloads the contents of a target GitHub repository into a given destination directory.

License

The MIT License (MIT)

Copyright (c) 2014 Alberto Beloni [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.