# git-user-email

> Get the email address of the current user from git config.

Latest version **0.2.2** (published 2016-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install git-user-email
pnpm add git-user-email
yarn add git-user-email
bun add git-user-email
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2016-10-29 |
| First published | 2014-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/git-user-email) |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Jon Schlinkert |
| Maintainers | doowb, jonschlinkert |
| Keywords | config, email, git, github, user |

## Links

- npm: https://www.npmjs.com/package/git-user-email
- Repository: https://github.com/jonschlinkert/git-user-email
- Issues: https://github.com/jonschlinkert/git-user-email/issues
- npm.io page: https://npm.io/package/git-user-email

## 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.0.2

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.2.2 (latest) — 2016-10-29
- 0.2.1 — 2015-03-31
- 0.2.0 — 2015-03-31
- 0.1.1 — 2014-04-04

## README

# git-user-email [![NPM version](https://img.shields.io/npm/v/git-user-email.svg?style=flat)](https://www.npmjs.com/package/git-user-email) [![NPM downloads](https://img.shields.io/npm/dm/git-user-email.svg?style=flat)](https://npmjs.org/package/git-user-email) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/git-user-email.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/git-user-email)

> Get the email address of the current user from git config.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save git-user-email
```

## Usage

```js
var email = require('git-user-email');
console.log(email());
//=> jon.schlinkert@sellside.com
```

## About

### Related 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-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.")

### Contributing

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

### Building docs

_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_

To generate the readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install -g verb verb-generate-readme && verb
```

### Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

### License

Copyright © 2016, [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.2.0, on October 29, 2016._

---
_Source: https://npm.io/package/git-user-email · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._