# nodegit > Node.js libgit2 asynchronous native bindings Latest version **0.27.0** (published 2020-07-28) · MIT license · 0 weekly downloads ## Install ```sh npm install nodegit pnpm add nodegit yarn add nodegit bun add nodegit ``` ## Health **Score 38/100 (D)** — status: abandoned. Positive: has types package; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads; no esm support; large bundle; pre 1.0. Negative: abandoned. ## Facts | | | |---|---| | Version | 0.27.0 | | Published | 2020-07-28 | | First published | 2011-03-10 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | separate (@types/nodegit) | | Module format | CommonJS | | Node | >= 6 | | Dependencies | 9 | | Unpacked size | 22.7 MB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | yes | | GitHub stars | 5749 | | Author | Tim Branyen | | Maintainers | faceleg, implausibility, johnhaley81, maxkorp, tbranyen | | Keywords | libgit2, git2, git, native | ## Links - npm: https://www.npmjs.com/package/nodegit - Repository: https://github.com/nodegit/nodegit - Homepage: http://nodegit.org - Issues: https://github.com/nodegit/nodegit/issues - npm.io page: https://npm.io/package/nodegit ## Dependencies (9) - [got](https://npm.io/package/got.md) ^10.7.0 - [nan](https://npm.io/package/nan.md) ^2.14.0 - [json5](https://npm.io/package/json5.md) ^2.1.0 - [ramda](https://npm.io/package/ramda.md) ^0.25.0 - [lodash](https://npm.io/package/lodash.md) ^4.17.14 - [tar-fs](https://npm.io/package/tar-fs.md) ^1.16.3 - [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0 - [node-gyp](https://npm.io/package/node-gyp.md) ^4.0.0 - [node-pre-gyp](https://npm.io/package/node-pre-gyp.md) ^0.13.0 ## Recent versions - 0.27.0 (latest) — 2020-07-28 - 0.28.0-alpha.38 (next) — 2026-04-23 - 0.0.103 (libssh2test) — 2015-12-15 - 0.0.10000005 (npmrc) — 2015-12-08 - 0.28.0-alpha.36 — 2025-11-24 - 0.28.0-alpha.35 — 2025-11-17 - 0.28.0-alpha.34 — 2025-07-23 - 0.28.0-alpha.33 — 2025-06-04 - 0.28.0-alpha.32 — 2025-05-28 - 0.28.0-alpha.31 — 2025-05-27 - 0.28.0-alpha.30 — 2025-02-14 - 0.28.0-alpha.29 — 2025-02-11 - 0.28.0-alpha.28 — 2024-07-02 - 0.28.0-alpha.27 — 2024-06-07 - 0.28.0-alpha.26 — 2024-04-19 - … 145 more at https://npm.io/package/nodegit/versions ## README # NodeGit > Node bindings to the [libgit2](http://libgit2.github.com/) project. [![Actions Status](https://github.com/nodegit/nodegit/workflows/Testing/badge.svg)](https://github.com/nodegit/nodegit/actions) **Stable (libgit2@v0.28.3): 0.28.3** ## Have a problem? Come chat with us! ## Visit [slack.libgit2.org](http://slack.libgit2.org/) to sign up, then join us in #nodegit. ## Maintained by ## Tyler Ang-Wanek [@twwanek](http://twitter.com/twwanek) with help from tons of [awesome contributors](https://github.com/nodegit/nodegit/contributors)! ### Alumni Maintainers ### Tim Branyen [@tbranyen](http://twitter.com/tbranyen), John Haley [@johnhaley81](http://twitter.com/johnhaley81), Max Korp [@maxkorp](http://twitter.com/MaximilianoKorp), Steve Smith [@orderedlist](https://twitter.com/orderedlist), Michael Robinson [@codeofinterest](http://twitter.com/codeofinterest), and Nick Kallen [@nk](http://twitter.com/nk) ## API Documentation. ## [http://www.nodegit.org/](http://www.nodegit.org/) ## Getting started. ## NodeGit will work on most systems out-of-the-box without any native dependencies. ``` bash npm install nodegit ``` If you receive errors about libstdc++, which are commonly experienced when building on Travis-CI, you can fix this by upgrading to the latest libstdc++-4.9. In Ubuntu: ``` sh sudo add-apt-repository ppa:ubuntu-toolchain-r/test sudo apt-get update sudo apt-get install libstdc++-4.9-dev ``` In Travis: ``` yaml addons: apt: sources: - ubuntu-toolchain-r-test packages: - libstdc++-4.9-dev ``` In CircleCI: ``` yaml dependencies: pre: - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test - sudo apt-get update - sudo apt-get install -y libstdc++-4.9-dev ``` If you receive errors about *lifecycleScripts* preinstall/install you probably miss *libssl-dev* In Ubuntu: ``` sudo apt-get install libssl-dev ``` You will need the following libraries installed on your linux machine: - libpcre - libpcreposix - libkrb5 - libk5crypto - libcom_err When building locally, you will also need development packages for kerberos and pcre, so both of these utilities must be present on your machine: - pcre-config - krb5-config If you are still encountering problems while installing, you should try the [Building from source](http://www.nodegit.org/guides/install/from-source/) instructions. ## API examples. ## ### Cloning a repository and reading a file: ### ``` javascript var Git = require("nodegit"); // Clone a given repository into the `./tmp` folder. Git.Clone("https://github.com/nodegit/nodegit", "./tmp") // Look up this known commit. .then(function(repo) { // Use a known commit sha from this repository. return repo.getCommit("59b20b8d5c6ff8d09518454d4dd8b7b30f095ab5"); }) // Look up a specific file within that commit. .then(function(commit) { return commit.getEntry("README.md"); }) // Get the blob contents from the file. .then(function(entry) { // Patch the blob to contain a reference to the entry. return entry.getBlob().then(function(blob) { blob.entry = entry; return blob; }); }) // Display information about the blob. .then(function(blob) { // Show the path, sha, and filesize in bytes. console.log(blob.entry.path() + blob.entry.sha() + blob.rawsize() + "b"); // Show a spacer. console.log(Array(72).join("=") + "\n\n"); // Show the entire file. console.log(String(blob)); }) .catch(function(err) { console.log(err); }); ``` ### Emulating git log: ### ``` javascript var Git = require("nodegit"); // Open the repository directory. Git.Repository.open("tmp") // Open the master branch. .then(function(repo) { return repo.getMasterCommit(); }) // Display information about commits on master. .then(function(firstCommitOnMaster) { // Create a new history event emitter. var history = firstCommitOnMaster.history(); // Create a counter to only show up to 9 entries. var count = 0; // Listen for commit events from the history. history.on("commit", function(commit) { // Disregard commits past 9. if (++count >= 9) { return; } // Show the commit sha. console.log("commit " + commit.sha()); // Store the author object. var author = commit.author(); // Display author information. console.log("Author:\t" + author.name() + " <" + author.email() + ">"); // Show the commit date. console.log("Date:\t" + commit.date()); // Give some space and show the message. console.log("\n " + commit.message()); }); // Start emitting events. history.start(); }); ``` For more examples, check the `examples/` folder. ## Unit tests. ## You will need to build locally before running the tests. See above. ``` bash npm test ``` --- _Source: https://npm.io/package/nodegit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._