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.
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
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.
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",
For more examples, check the examples/ folder.
Unit tests.
You will need to build locally before running the tests. See above.