Package Exports

git-clone

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (git-clone) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

git-clone

Clone a git repository via git shell command.

Installation

Install:

$ npm install git-clone

To use the original callback-based API:

const clone = require('git-clone');

As of 0.2.0 there's a promised-based API for use with async/await:

const clone = require('git-clone/promise');

API

Common Options

git: path to git binary; default: git (expected to be in your $PATH)
shallow: when true, clone with depth 1
checkout: revision/branch/tag to check out after clone
args: additional array of arguments to pass to git clone

Callback

`clone(repo, targetPath, [options], cb)`

Clone repo to targetPath, calling cb on completion; any error that occurred will be passed as the first argument. If no error is passed the git clone operation was successful.

Promise

`async clone(repo, targetPath, [options])`

Clone repo to targetPath, throwing an exception on failure.

Contributors

AntiMoron

Copyright & License

Released under the ISC license.