list-git-branches

List the branches for a git repository.

Install

Install with npm:

$ npm install --save list-git-branches

Install with yarn:

$ yarn add list-git-branches

Usage

var branches = require('list-git-branches');
var cwd = '.';

// async
branches(cwd, function(err, res) {
  if (err) throw err;
  console.log(res);
});

// sync
console.log(branches.sync(cwd));

You can optionally pass an options object as the second argument, to be passed to .exec or .execSync.

About

Related projects

• gfc: Simple way to initialize a new git repository in an empty directory, add a file… more | homepage
• git-add-remote: API for adding git remotes. | homepage
• git-branch: Get the current branch for a local git repository. | homepage
• git-config-path: Resolve the path to the user's local or global .gitconfig. | 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
• list-git-remotes: List the remotes for a local git repository. Sync and async. | 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.