# node-gitconfiglocal

**Repository Path**: mirrors_rexxars/node-gitconfiglocal

## Basic Information

- **Project Name**: node-gitconfiglocal
- **Description**: parse the .git/config file into a useful data structure
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-09
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/soldair/node-gitconfiglocal.svg?branch=master)](https://travis-ci.org/soldair/node-gitconfiglocal)

# gitconfiglocal

parse the `.git/config` file into a useful data structure

## example

- search config in $GIT_DIR (.git by default)

```js
var gitconfig = require('@rexxars/gitconfiglocal');

gitconfig('./').then((config) => {
  console.log(config);
  /* prints:
  { core:
     { repositoryformatversion: '0',
       filemode: true,
       bare: false,
       logallrefupdates: true },
    remote:
     { origin:
        { url: 'git@github.com:soldair/node-gitconfiglocal.git',
          fetch: '+refs/heads/*:refs/remotes/origin/*' } } }
  */
});
```

- specify $GIT_DIR via options:

```js
gitconfig('./', { gitDir: 'path/to/gitdir' });
```

## license

licensed under the [3-Clause BSD license](./LICENSE).