Extract the username from a git remote origin URL.
MIT License
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 ❤️ and support.
Install with npm:
$ npm install --save git-username
If no arguments are passed, the .git/config
in the current working directory is used.
var username = require('git-username');
console.log(username()); //=> jonschlinkert
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');
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 });
Breaking changes
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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
(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
You might also be interested in these projects:
.git/config
into a JavaScript object. sync or async. | homepage
Commits | Contributor |
---|---|
21 | jonschlinkert |
1 | davisjam |
1 | jamo |
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on March 02, 2018.