clone-repos
v0.1.4
Published
Clone all of a user's github repositories.
Downloads
9
Readme
clone-repos
Clone all of a user's github repositories.
Install
Install with npm:
$ npm install --save clone-repos
Usage
var cloneRepos = require('clone-repos');
API
.clone
Clone all repositories for the specified owner
. All repositories will be cloned into a folder with the owner's name. The options.dest
property may be set to specify where the repositories are cloned.
Params
options
{Object}options.owner
{String|Array}: Githubuser
ororg
name to clone.options.dest
{String}: Destination folder for cloned repositories (defaults toowner
).options.auth
{Object}: Authentication object to use to authenticate to github to extend github api limits.options.auth.type
{String}: Authentication type to use. May bebasic
oroauth
.options.auth.username
{String}: Githubusername
to use when usingbasic
authentication.options.auth.password
{String}: Githubpassword
to use when usingbasic
authentication.options.auth.token
{String}: Github personal access token to use when usingoauth
authentication.options.filter
{Function}: Optional filter function to filter out repositories that should not be cloned.cb
{Function}: Callback function called witherr
andrepos
object containing list of cloned repositories.
Example
clone({owner: 'doowb'}, function(err, repos) {
if (err) return console.error(err);
console.log('cloned', repos);
});
About
Related projects
github-base: Base methods for creating node.js apps that work with the GitHub API. | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Brian Woodward
License
Copyright © 2016, Brian Woodward. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.30, on August 22, 2016.