git-user-name

Get a user's name from git config at the project or global scope, depending on what git uses in the current context.

Install

Install with npm:

$ npm install git-user-name --save

Usage

var username = require('git-user-name');
console.log(username()); // log the local git user name
console.log(username(true)); // log the global git user name
//=> jonschlinkert

Related projects

• git-branch: Get the current branch for a local git repository. | homepage
• git-config-path: Resolve the path to the user's global .gitconfig. | homepage
• git-repo-name: Get the repository name from the git remote origin URL. | homepage
• git-user-email: Get the email address of the current user from git config. | homepage
• git-username: Get the username from a git remote origin URL. | homepage
• parse-git-config: Parse .git/config into a JavaScript object. sync or async. | 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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

---

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