node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

vcs-clone

vcs-clone

Build Status

An abstract VCS clone module inspired by Golang and ghq.

Supported VCSs are:

  • Git
  • Mercurial
  • Subversion (Optional)

Requirements

  • Node.js (>= 0.12.0) or io.js (>= 1.0.0)

Installation

$ npm install vcs-clone

Usage

Command Line Interface

$ vcsc github.com/MisumiRize/vcs-clone

Basic

Because vcs-clone uses Generator syntax, --harmony option is required on Node.js.

var VCSClone = require('vcs-clone');
 
VCSClone.clone('github.com/MisumiRize/vcs-clone', '/path/to/root')
  .then(function(vcs) {
    console.log(vcs);
  })
  .catch(function(err) {
    console.log(err);
  });

VCSClone.clone() returns Promise.

Update if directory exists

VCSClone.clone('github.com/MisumiRize/vcs-clone/', '/path/to/root', {update: true})