Git Product home page Git Product logo

git-cloner's Introduction

git-cloner

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Clone multiple git repositories.

☁️ Installation

# Using npm
npm install --save git-cloner

# Using yarn
yarn add git-cloner

πŸ“‹ Example

const gitCloner = require("git-cloner");

gitCloner([
    "IonicaBizau/git-stats"
  , {
        source: "IonicaBizau/node-cobol#1.5.0"
      , path: "a/bridge/to/1959"
    }
], `${__dirname}/clones`, (err, data) => {
    console.log(err || data);
});

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. πŸ›
  3. For direct and quick help, you can use Codementor. πŸš€

πŸ“ Documentation

gitCloner(input, options, cb)

Clones the git repositories specified in the input parameter.

Params

  • Array input: An array of git sources: git urls (it also supports owner/repo notation, parsed by git-source), or objects in this format:

  • source (String): The source of the git repository.

  • path (String): The custom folder name/path where the repository should be cloned.

  • Object options: An object containing the following fields:

  • dest (String): The folder where to clone the repositories (default: ".")

  • urlType (String): The git url type (default: "ssh").

  • showOutput (Boolean): If true, the child process output streams will be piped in the main process.

  • done (Function): A function to be called after each repo was cloned.

  • parallelLimit (Number): A number representing the max count of git cloning processes in the same time (default: 5).

  • shallow (Boolean): If true, a shallow clone will be created (i.e. --depth=1).

  • Function cb: The callback function.

πŸ˜‹ How to contribute

Have an idea? Found a bug? See how to contribute.

πŸ’– Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like πŸš€

  • Buy me a bookβ€”I love books! I will remember you after years if you buy me one. 😁 πŸ“–

  • PayPalβ€”You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍡

  • Support me on Patreonβ€”Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoinβ€”You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❀️

πŸ’« Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

  • agc
  • git-module-installer
  • devcloud

πŸ“œ License

MIT © Ionică Bizău

git-cloner's People

Contributors

ionicabizau avatar turbo87 avatar

Stargazers

Sam Walsh avatar  avatar Rust Oceans avatar Vaughan Rouesnel avatar Jerzerak avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

turbo87

git-cloner's Issues

Submodules without paths causing error when NPM installing via Git

I was trying to npm install this lib via Git instead of NPM itself and ran into this error:

npm ERR! Command failed: git submodule -q update --init --recursive
npm ERR! fatal: No url found for submodule path 'example/clones/a/bridge/to/1959' in .gitmodules

Is there any reason for having the submodules at all? Removing them seems to solve the issue.

Shallow cloning support

For my current use case I only need the most recent state of the repository without the history. It would be great if the library supported shallow cloning (i.e. git clone --depth 1).

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.