remote-origin-url

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

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

Install

Install with npm:

1$ npm install --save remote-origin-url

Usage

1const origin = require('remote-origin-url');

async/await

1(async() => {
2  let url = await origin();
3  console.log(url);
4  // url => "https://github.com/jonschlinkert/remote-origin-url.git"
5})();

Callback

1origin((err, url) => {
2  if (err) return console.log(err);
3  console.log(url);
4  // url => "https://github.com/jonschlinkert/remote-origin-url.git"
5});

cwd

Specify the current working directory to use:

1origin(process.cwd(), (err, url) => {
2  if (err) return console.log(err);
3  console.log(url);
4  // url => "https://github.com/jonschlinkert/remote-origin-url.git"
5});

sync

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

Specify the cwd to use:

1console.log(origin.sync(process.cwd()));
2//=> "https://github.com/jonschlinkert/remote-origin-url.git"

Release history

v2.0.0

Now returns a promise if a callback is not supplied.

v1.0.0

No significant changes, just minor code formatting. it's time for a 1.0 release!

v0.5.3

bug fixes

Pass an object to parse-git-config to ensure that path is used.

About

1$ npm install && npm test

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

Related projects

You might also be interested in these projects:

• git-config-path: Resolve the path to the user's local or 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 (or 'owner' name) from a git/GitHub 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

Contributors

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

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

This file was generated by verb-generate-readme, v0.8.0, on November 22, 2018.