Download and extract a git repository (GitHub, GitLab, Bitbucket) from node.

$ npm install download-git-repo

Download a git repository to a destination folder with options, and callback.

The short hand repository string to download the repository from.

• GitHub - github:owner/name or simply owner/name
• GitLab - gitlab:owner/name
• Bitbucket - bitbucket:owner/name

The repository parameter defaults to the master branch, but you can specify a branch or tag as a URL fragment like owner/name#my-branch. Feel free to submit an issue or pull request for additional host options.

The file path to download the repository to.

An optional options object parameter with download options. Options include:

• clone - boolean default false - If true use git clone instead of an http download. While this can be a bit slower, it does allow private repositories to be used if the appropriate SSH keys are setup.

The callback function as function(err).

Using http download from Github repository at master.

download('zeke/download-github-repo-fixture', 'test/tmp', function(err) {
  if (err) return done(err);
  done();
});

Using git clone from Bitbucket repository at my-branch.

download('bitbucket:flipxfx/download-bitbucket-repo-fixture#my-branch', 'test/tmp', { clone: true }, function(err) {
  if (err) return done(err);
  done();
});

To ianstormtaylor/download-github-repo for the head start.

MIT