jonschlinkert / list-git-remotes

List the remotes for a local git repository. Sync and async.

list-git-remotes

List the remotes for a local git repository. Sync and async.

Install

Install with npm:

$ npm install --save list-git-remotes

Install with yarn:

$ yarn add list-git-remotes

Usage

var remotes = require('list-git-remotes');

console.log(remotes.sync('some/project'));
//=> { origin: 'https://github.com/jonschlinkert/list-git-remotes.git' }

remotes('some/project', function(err, res) {
  if (err) throw err;
  console.log(res);
  //=> { origin: 'https://github.com/jonschlinkert/list-git-remotes.git' }
});

About

Related projects

• git-branch: Get the current branch for a local git repository. | homepage
• git-user-email: Get the email address of the current user from git config. | 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

Contributing

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

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

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

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

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

---

This file was generated by verb-generate-readme, v0.5.0, on April 19, 2017.