JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 76
  • Score
    100M100P100Q78306F
  • License MIT

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

Package Exports

  • git-pull-or-clone
  • git-pull-or-clone/index.js

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-pull-or-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-pull-or-clone ci 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('git@github.com: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.