# nodegit-lfs

> A wrapper for NodeGit to facilitate LFS Support

Latest version **0.1.0** (published 2018-01-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install nodegit-lfs
pnpm add nodegit-lfs
yarn add nodegit-lfs
bun add nodegit-lfs
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-01-11 |
| First published | 2017-08-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 15 |
| Author | Axosoft, LLC |
| Maintainers | carsonh |
| Keywords | node, git, lfs, nodegit |

## Links

- npm: https://www.npmjs.com/package/nodegit-lfs
- Repository: https://github.com/Axosoft/nodegit-lfs
- Homepage: https://github.com/Axosoft/nodegit-lfs#readme
- Issues: https://github.com/Axosoft/nodegit-lfs/issues
- npm.io page: https://npm.io/package/nodegit-lfs

## Dependencies (7)

- [tmp](https://npm.io/package/tmp.md) ^0.0.33
- [ramda](https://npm.io/package/ramda.md) ^0.24.1
- [ignore](https://npm.io/package/ignore.md) ^3.3.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^3.0.1
- [node-pty](https://npm.io/package/node-pty.md) ^0.7.4
- [default-shell](https://npm.io/package/default-shell.md) ^1.0.1
- [promisify-node](https://npm.io/package/promisify-node.md) ^0.4.0

## 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.1.0 (latest) — 2018-01-11
- 0.0.19 — 2017-12-12
- 0.0.18 — 2017-10-25
- 0.0.17 — 2017-10-25
- 0.0.16 — 2017-10-20
- 0.0.15 — 2017-10-06
- 0.0.13 — 2017-09-25
- 0.0.12 — 2017-09-19
- 0.0.11 — 2017-09-05
- 0.0.10 — 2017-09-01
- 0.0.9 — 2017-08-31
- 0.0.8 — 2017-08-30
- 0.0.7 — 2017-08-30
- 0.0.6 — 2017-08-30
- 0.0.5 — 2017-08-30
- … 4 more at https://npm.io/package/nodegit-lfs/versions

## README

# NodeGit LFS

Nodegit LFS is an extension library used to augment [NodeGit](http://www.nodegit.org/) with the capability to use [git lfs](https://git-lfs.github.com/) via the command line.

To use this package, you must have [git](https://git-scm.com/) and [git lfs](https://git-lfs.github.com/) installed.

This project is new, and is highly volatile. It should be noted that any subsequesnt releases may have breaking changes for the foreseeable future.

## How to get started

`NodeGit` is a peer dependency of the `NodeGit LFS` package, so you should make sure to install `NodeGit` before `NodeGit LFS`.

To install `NodeGit` run:

`yarn add nodegit`

To install `NodeGit LFS` run:

`yarn add nodegit-lfs`

Once installed, you only need to bootstrap `NodeGit LFS` once:

```javascript
const nodegit = require('nodegit');
const addLfs = require('nodegit-lfs');

// Call the function returned from nodegit-lfs with nodegit as a parameter
// and you are good to go!
addLfs(nodegit);

// After nodegit has been augmented you can use LFS via the LFS object
nodegit.LFS.register()
  .then(() => {
    console.log('The LFS filter has been registered!');
  });
```

## Building from source

Clone the repo:

`git clone https://github.com/axosoft/nodegit-lfs`

Once cloned:

```
cd nodegit-lfs
yarn
```

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