Giter Club home page Giter Club logo

git-pull-or-clone's Introduction

git-pull-or-clone travis npm downloads

Ensure a git repo exists on disk and that it's up-to-date

Install

npm install git-pull-or-clone

Usage

const gitPullOrClone = require('git-pull-or-clone')

gitPullOrClone('[email protected]:feross/standard.git', '/path/to/destination', (err) => {
  if (err) throw err
  console.log('SUCCESS!')
})

API

gitPullOrClone(url, outPath[, options], callback)

Ensure a git repo exists on disk and that it's up-to-date.

Clones the git repo specified by url to the path outPath. If the repo already exists on disk, then a pull is performed to update the repo instead.

The git repo is shallowly cloned by default. To make a complete clone, set options.depth to Infinity. If the git repo was previously cloned shallowly, it remains shallow.

When the operation is finished, callback is called. The first argument to callback is either null or an Error object if an error occurred.

License

MIT. Copyright (c) Feross Aboukhadijeh.

git-pull-or-clone's People

Contributors

feross avatar greenkeeper[bot] avatar vweevers 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.