Native Node bindings to Git.
Clone or download
rcjsuen Merge pull request #1586 from foolip/patch-1
Fix typo in GitHub issue template
Latest commit eeb2e38 Nov 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix typo in GitHub issue template Nov 19, 2018
.travis TravisCI: Create and push tags Nov 21, 2015
examples Bump fs-extra to get rid of most promisify calls in nodegit Sep 25, 2018
generate Merge pull request #1570 from implausible/garbage-collection/free-alm… Oct 25, 2018
guides Fix variable name. May 13, 2018
lib Fix tests Oct 17, 2018
lifecycleScripts That linter though... Oct 1, 2018
test Extraneous test Oct 25, 2018
utils Copy libssh2 config headers straight into `vendor/libssh2` Oct 17, 2018
vendor Copy libssh2 config headers straight into `vendor/libssh2` Oct 17, 2018
.astylerc prettify generated output Nov 25, 2014
.editorconfig Added editor config Nov 24, 2014
.gitignore Copy libssh2 config headers straight into `vendor/libssh2` Oct 17, 2018
.gitmodules Add submodule for http_parser at 2.5.0 Sep 24, 2018
.jshintrc ES6 support for JSHint Apr 29, 2016
.npmignore Bring life cycle in line with npm standards Jun 14, 2016
.travis.yml Bump to v0.23.0 Oct 22, 2018
CHANGELOG.md Bump to v0.24.0-alpha.1 Oct 25, 2018
CONTRIBUTING.md Fix typos Dec 16, 2017
FAQ.md Start up a FAQ Mar 22, 2016
HISTORY.md fix a few things Nov 25, 2014
LICENSE Updated the license date and binding to latest. Apr 30, 2014
README.md Bump to v0.23.0-alpha.1 Oct 2, 2018
TESTING.md Fix incorrect anchor link in TESTING.md Jan 3, 2017
appveyor.yml AppVeyor: Build with newer Node versions first Oct 1, 2018
package-lock.json Bump to v0.24.0-alpha.1 Oct 25, 2018
package.json Bump to v0.24.0-alpha.1 Oct 25, 2018

README.md

NodeGit

Node bindings to the libgit2 project.

Linux & macOS Windows Coverage Dependencies
Build Status Travis Build Status AppVeyor Coveralls Dependencies

Stable (libgit2@v0.27.3): 0.27.3

Have a problem? Come chat with us!

Visit slack.libgit2.org to sign up, then join us in #nodegit.

Maintained by

Tim Branyen @tbranyen, John Haley @johnhaley81, and Max Korp @maxkorp with help from tons of awesome contributors!

Alumni Maintainers

Steve Smith @orderedlist, Michael Robinson @codeofinterest, and Nick Kallen @nk

API Documentation.

http://www.nodegit.org/

Getting started.

NodeGit will work on most systems out-of-the-box without any native dependencies.

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:

sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update
sudo apt-get install libstdc++-4.9-dev

In Travis:

addons:
  apt:
    sources:
      - ubuntu-toolchain-r-test
    packages:
      - libstdc++-4.9-dev

In CircleCI:

  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

Additionally, you need curl-config on your system. You need one of these packages:

  • libcurl4-gnutls-dev
  • libcurl4-nss-dev
  • libcurl4-openssl-dev

If you are still encountering problems while installing, you should try the Building from source instructions.

API examples.

Cloning a repository and reading a file:

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:

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.

npm test