# 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.
Latest version **2.0.0** (published 2017-10-17) · MIT license · 0 weekly downloads
## Install
```sh
npm install git-user-name
pnpm add git-user-name
yarn add git-user-name
bun add git-user-name
```
## 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 | 2.0.0 |
| Published | 2017-10-17 |
| First published | 2014-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/git-user-name) |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 21 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | git, gitconfig, github, global, name, user, username |
## Links
- npm: https://www.npmjs.com/package/git-user-name
- Repository: https://github.com/jonschlinkert/git-user-name
- Issues: https://github.com/jonschlinkert/git-user-name/issues
- npm.io page: https://npm.io/package/git-user-name
## Dependencies (3)
- [extend-shallow](https://npm.io/package/extend-shallow.md) ^2.0.1
- [git-config-path](https://npm.io/package/git-config-path.md) ^1.0.1
- [parse-git-config](https://npm.io/package/parse-git-config.md) ^1.1.1
## 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
- 2.0.0 (latest) — 2017-10-17
- 1.2.1 — 2017-10-17
- 1.2.0 — 2016-03-19
- 1.1.2 — 2015-03-31
- 1.1.1 — 2015-03-04
- 1.1.0 — 2015-03-04
- 1.0.2 — 2015-03-04
- 1.0.1 — 2015-02-27
- 0.1.0 — 2014-04-04
## README
# git-user-name [](https://www.npmjs.com/package/git-user-name) [](https://npmjs.org/package/git-user-name) [](https://npmjs.org/package/git-user-name) [](https://travis-ci.org/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.
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-user-name
```
## Usage
```js
var userName = require('git-user-name');
console.log(userName());
//=> jonschlinkert
```
## 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-config-path](https://www.npmjs.com/package/git-config-path): Resolve the path to the user's local or global .gitconfig. | [homepage](https://github.com/jonschlinkert/git-config-path "Resolve the path to the user's local or global .gitconfig.")
* [git-repo-name](https://www.npmjs.com/package/git-repo-name): Get the repository name from the git remote origin URL. | [homepage](https://github.com/jonschlinkert/git-repo-name "Get the repository name from the git remote origin URL.")
* [git-user-email](https://www.npmjs.com/package/git-user-email): Get the email address of the current user from git config. | [homepage](https://github.com/jonschlinkert/git-user-email "Get the email address of the current user from git config.")
* [git-username](https://www.npmjs.com/package/git-username): Get the username from a git remote origin URL. | [homepage](https://github.com/jonschlinkert/git-username "Get the username from a git remote origin URL.")
* [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.")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 19 | [jonschlinkert](https://github.com/jonschlinkert) |
| 3 | [noyobo](https://github.com/noyobo) |
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [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 October 17, 2017._
---
_Source: https://npm.io/package/git-user-name · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._