# git-refs

> finds all references of a git repository

Latest version **1.1.3** (published 2015-06-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install git-refs
pnpm add git-refs
yarn add git-refs
bun add git-refs
```

Provides the command `git-refs`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2015-06-08 |
| First published | 2015-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Christoph Witzko |
| Maintainers | christophwitzko |
| Keywords | git, refs |

## Links

- npm: https://www.npmjs.com/package/git-refs
- Repository: https://github.com/christophwitzko/git-refs
- Issues: https://github.com/christophwitzko/git-refs/issues
- npm.io page: https://npm.io/package/git-refs

## Dependencies (3)

- [walk](https://npm.io/package/walk.md) ^2.3.9
- [slash](https://npm.io/package/slash.md) ^1.0.0
- [path-object](https://npm.io/package/path-object.md) ^2.3.0

## Recent versions

- 1.1.3 (latest) — 2015-06-08
- 1.1.2 — 2015-02-11
- 1.1.1 — 2015-02-10
- 1.1.0 — 2015-02-10
- 1.0.0 — 2015-02-10

## README

# git-refs
[![Build Status](https://travis-ci.org/christophwitzko/git-refs.svg)](https://travis-ci.org/christophwitzko/git-refs)

## Install

    $ npm install -g git-refs


## Example

```javascript
var gitRefs = require('git-refs')

gitRefs('/path/to/.git', function (err, data) {
  if (err) return console.log(err)
  console.dir(data)
  // data is a path-object (http://git.io/Nh7p)
  console.log('master:', data.get('heads/master'))
  console.dir(data.get('tags'))
  console.dir(data.dump())
})
```

## Licence

The [MIT License (MIT)](http://opensource.org/licenses/MIT)

Copyright © 2015 [Christoph Witzko](https://twitter.com/christophwitzko)

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