git-username

Get the username (or 'owner' name) from a git/GitHub remote origin URL.

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

Install

Install with npm:

$ npm install --save git-username

Usage

If no arguments are passed, the .git/config in the current working directory is used.

var username = require('git-username');
console.log(username()); //=> jonschlinkert

Options

options.cwd

Type: string

Default: process.cwd()

Set the current working directory (cwd):

Examples

username({ cwd: 'some/path' });

// cwd may also be passed as the first argument
username('some/path');

options.strict

Type: boolean

Default: undefined

Throw an error when a git config or git remote origin cannot be resolved. Otherwise, when strict is not true and a remote origin cannot be resolved, null is returned.

Example

username({ strict: true });

Release history

v1.0

Breaking changes

The second argument can no longer be a boolean (for warning when git remote origin is not found). Use options.strict instead.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

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: ```sh $ npm install && npm test ```

Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ```

Related projects

You might also be interested in these projects:

git-branch: Get the current branch for a local git repository. | homepage
git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
parse-git-config: Parse .git/config into a JavaScript object. sync or async. | homepage
remote-origin-url: Get the git remote origin URL from your local git repository. Remember! A remote origin… more | homepage

Contributors

Commits	Contributor
21	jonschlinkert
1	davisjam
1	jamo

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.6.0, on March 02, 2018.

jonschlinkert / git-username

readme