JSPM

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

git clone a repo with only username/repo, or if it's an NPM package you can use just the name of the project.

Package Exports

  • gh-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 (gh-clone) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gh-clone NPM version NPM monthly downloads NPM total downloads Linux Build Status

git clone a repo with only username/repo, or if it's an NPM package you can use just the name of the project.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install globally with npm

$ npm install --global gh-clone

CLI Usage

Clone a github repository:

$ gh-clone <repo> [options]
  • repo - one or more space-separated repository names
  • options options flags to pass to gh-clone

Examples

repository name

If the repository is a NPM package, you can pass the name only, and gh-clone will resolve the git URL from the library's package.json:

$ gh-clone isobject

owner/repo

Pass the github repository formatted as owner/repo:

$ gh-clone jonschlinkert/isobject

Options

Shortcut Flag Description
-c --cwd the current working directory (defaults to process.cwd())
-d --dest the local destination directory to clone the repository to
-b --branch the branch to clone

Note that if the --dest flag is used when cloning multiple repositories, the name of each repository will be appended to the dest value.

Examples

branch

Flags can be used in any order. If you want the dev branch of micromatch (when one exists):

$ gh-clone jonschlinker/micromatch -b dev

destination

If you want to save to the foo directory

$ gh-clone jonschlinker/micromatch -d foo

branch and destination

If you want to save the dev branch to the foo directory

$ gh-clone jonschlinker/micromatch -b dev -d foo

API Usage

Params

  • repos {String|Array}
  • options {Object}
  • callback {Function}: Optional, returns a promise if the callback is not passed.
  • returns {Promise}: if a callback is not passed.

Example

const clone = require('gh-clone');
clone('kind-of', function(err) {
  if (err) console.error(err);
});

// or
clone(['isobject', 'kind-of'])
  .then(function() {
    // do stuff
  })
  .catch(console.error)

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

You might also be interested in these projects:

Contributors

Commits Contributor
30 jonschlinkert
12 doowb
1 johno
1 theuves

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on May 28, 2018.