Package Exports

remote-origin-url

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

Readme

remote-origin-url

Get the git remote origin URL from your local git repository. Remember! A remote origin must exist first!

Install

Install with npm:

$ npm install remote-origin-url --save

Install with bower

$ bower install remote-origin-url --save

Usage

Using the defaults:

var url = require('remote-origin-url');
url(function (err, res) {
  // res => "https://github.com/jonschlinkert/remote-origin-url.git"
})

Specify the cwd to use:

url(__dirname, function (err, res) {
  // res => "https://github.com/jonschlinkert/remote-origin-url.git"
})

sync

url.sync();
//=> "https://github.com/jonschlinkert/remote-origin-url.git"

Specify the cwd to use:

url.sync(__dirname);
//=> "https://github.com/jonschlinkert/remote-origin-url.git"

git-config-path: Resolve the path to the user's global .gitconfig. | homepage
git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
git-username: Get the username from a git remote origin URL. | homepage
is-git-url: Regex to validate that a URL is a git url. | homepage
parse-github-url: Parse a github URL into an object. | homepage

Contributing

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

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

This file was generated by verb, v0.9.0, on March 19, 2016.