# git-username
> Get the username (or 'owner' name) from a git/GitHub remote origin URL.
Latest version **1.0.0** (published 2018-03-03) · MIT license · 0 weekly downloads
## Install
```sh
npm install git-username
pnpm add git-username
yarn add git-username
bun add git-username
```
## Health
**Score 23/100 (F)** — status: abandoned.
Positive: has types package; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-03-03 |
| First published | 2014-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/git-username) |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 2 |
| Unpacked size | 8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | git, name, origin, parse, remote, remote origin, remote origin url, url, user, username |
## Links
- npm: https://www.npmjs.com/package/git-username
- Repository: https://github.com/jonschlinkert/git-username
- Issues: https://github.com/jonschlinkert/git-username/issues
- npm.io page: https://npm.io/package/git-username
## Dependencies (2)
- [parse-github-url](https://npm.io/package/parse-github-url.md) ^1.0.2
- [remote-origin-url](https://npm.io/package/remote-origin-url.md) ^1.0.0
## Alternatives
- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads
## Recent versions
- 1.0.0 (latest) — 2018-03-03
- 0.5.1 — 2018-02-26
- 0.5.0 — 2017-01-02
- 0.4.0 — 2015-02-27
- 0.3.1 — 2015-02-27
- 0.3.0 — 2015-02-27
- 0.2.0 — 2014-05-15
- 0.1.2 — 2014-04-04
- 0.1.1 — 2014-04-04
- 0.1.0 — 2014-04-04
## README
# git-username [](https://www.npmjs.com/package/git-username) [](https://npmjs.org/package/git-username) [](https://npmjs.org/package/git-username) [](https://travis-ci.org/jonschlinkert/git-username)
> Get the username (or 'owner' name) from a git/GitHub remote origin URL.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save git-username
```
## Usage
If no arguments are passed, the `.git/config` in the current working directory is used.
```js
var username = require('git-username');
console.log(username()); //=> jonschlinkert
```
## Options
### options.cwd
**Type**: `string`
**Default**: `process.cwd()`
Set the current working directory (cwd):
**Examples**
```js
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**
```js
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](#optionsstrict) 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](https://www.npmjs.com/package/git-branch): Get the current branch for a local git repository. | [homepage](https://github.com/jonschlinkert/git-branch "Get the current branch for a local git repository.")
* [git-user-name](https://www.npmjs.com/package/git-user-name): Get a user's name from git config at the project or global scope, depending on… [more](https://github.com/jonschlinkert/git-user-name) | [homepage](https://github.com/jonschlinkert/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.")
* [parse-git-config](https://www.npmjs.com/package/parse-git-config): Parse `.git/config` into a JavaScript object. sync or async. | [homepage](https://github.com/jonschlinkert/parse-git-config "Parse `.git/config` into a JavaScript object. sync or async.")
* [remote-origin-url](https://www.npmjs.com/package/remote-origin-url): Get the git remote origin URL from your local git repository. Remember! A remote origin… [more](https://github.com/jonschlinkert/remote-origin-url) | [homepage](https://github.com/jonschlinkert/remote-origin-url "Get the git remote origin URL from your local git repository. Remember! A remote origin must exist first!")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 21 | [jonschlinkert](https://github.com/jonschlinkert) |
| 1 | [davisjam](https://github.com/davisjam) |
| 1 | [jamo](https://github.com/jamo) |
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](http://github.com/https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 02, 2018._
---
_Source: https://npm.io/package/git-username · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._