# git-config-path
> Resolve the path to the user's local or global .gitconfig.
Latest version **2.0.0** (published 2018-11-18) · MIT license · 0 weekly downloads
## Install
```sh
npm install git-config-path
pnpm add git-config-path
yarn add git-config-path
bun add git-config-path
```
## 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 | 2018-11-18 |
| First published | 2015-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/git-config-path) |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | config, git, gitconfig, global, path, resolve |
## Links
- npm: https://www.npmjs.com/package/git-config-path
- Repository: https://github.com/jonschlinkert/git-config-path
- Issues: https://github.com/jonschlinkert/git-config-path/issues
- npm.io page: https://npm.io/package/git-config-path
## 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) — 2018-11-18
- 1.0.1 — 2016-10-26
- 1.0.0 — 2016-10-26
- 0.2.1 — 2016-10-26
- 0.2.0 — 2016-03-29
- 0.1.0 — 2015-03-04
## README
# git-config-path [](https://www.npmjs.com/package/git-config-path) [](https://npmjs.org/package/git-config-path) [](https://npmjs.org/package/git-config-path) [](https://travis-ci.org/jonschlinkert/git-config-path)
> Resolve the path to the user's local or global .gitconfig.
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-config-path
```
## Usage
Automatically gets the nearest `.git` config path, starting with the current working directory, then looking in the user's `home` directory.
```js
var gitConfigPath = require('git-config-path')();
//=> '/Users/jonschlinkert/dev/git-config-path/.git/config'
```
To force `git-config-path` to only look for a global config path, pass `global`:
```js
var gitConfigPath = require('git-config-path')('global');
//=> '/Users/jonschlinkert/.gitconfig'
```
## 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 from the local git repository. | [homepage](https://github.com/jonschlinkert/git-branch "Get the current branch from the local git repository.")
* [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-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.")
* [git-username](https://www.npmjs.com/package/git-username): Get the username (or 'owner' name) from a git/GitHub remote origin URL. | [homepage](https://github.com/jonschlinkert/git-username "Get the username (or 'owner' name) from a git/GitHub remote origin URL.")
* [is-git-url](https://www.npmjs.com/package/is-git-url): Regex to validate that a URL is a git url. | [homepage](https://github.com/jonschlinkert/is-git-url "Regex to validate that a URL is a git 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.")
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](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.8.0, on November 18, 2018._
---
_Source: https://npm.io/package/git-config-path · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._