Giter Club home page Giter Club logo

clone-repos's Introduction

clone-repos NPM version Build Status

Clone all of a user's github repositories.

Install with npm:

$ npm i clone-repos --save

Usage

var cloneRepos = require('clone-repos');

API

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}: Github user or org name to clone.
  • options.dest {String}: Destination folder for cloned repositories (defaults to owner).
  • 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 be basic or oauth.
  • options.auth.username {String}: Github username to use when using basic authentication.
  • options.auth.password {String}: Github password to use when using basic authentication.
  • options.auth.token {String}: Github personal access token to use when using oauth authentication.
  • cb {Function}: Callback function called with err and repos object containing list of cloned repositories.

Example

clone({owner: 'doowb'}, function(err, repos) {
  if (err) return console.error(err);
  console.log('cloned', repos);
});

Related projects

github-base: Base methods for creating node.js apps that work with the GitHub API. | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Brian Woodward

License

Copyright © 2016 Brian Woodward Released under the MIT license.


This file was generated by verb on January 12, 2016.

clone-repos's People

Contributors

doowb avatar

Watchers

Jon Schlinkert avatar James Cloos 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.