Node.js bindings for libgit2
JavaScript C++ CSS Python Makefile CoffeeScript C
Failed to load latest commit information.
deps added hash helpers Jun 23, 2014
docs Documentation efforts ongoing. Jul 26, 2013
examples clone now resolves HEAD ref commit tree and checks it out into workin… Jun 2, 2012
lib fix scope problems in lib Jun 6, 2014
src removed coffee dep completely Jun 6, 2014
test
.dntrc removed coffee dep completely Jun 5, 2014
.gitignore
.gitmodules moved libgit2 submodule from vendor/ to deps/. Updated to v0.17.0 tag. Jun 6, 2012
.jscs.json add jscs rule set Apr 9, 2014
.npmignore fix postinstall step Sep 22, 2014
.travis.yml using NAN , DNT for local testing and works in 0.8,0.10 Jun 3, 2014
CHANGELOG.md Merge branch 'devel' Apr 3, 2011
LIBGIT2_BUGS.md zomgawd basic clone!! Jun 1, 2012
LICENSE Added MIT license. Mar 8, 2011
README.md
TODO.md Basic preinstall script to check cmake is installed. May 8, 2013
binding.gyp link through dependencies in gyp Jun 23, 2014
install.js fix postinstall step Sep 22, 2014
package.json

README.md

Gitteh

build status npm version Dependency Status devDependency Status

Installation

Gitteh requires node 0.8 or 0.10, CMake 2.6 and gcc. Installation via NPM:

npm install gitteh

What?

Node bindings to the excellent libgit2 C library. Right now, the bindings cover read only access to raw objects (trees/commits/blobs/tags/references), and basic access to remotes (including basic cloning/fetching support).

Gitteh aims to:

  • Be simple and convenient
  • Be as performant as possible - avoids calling into underlying C library as much as possible.
  • Be safe for use in Node's threadpool (read: shouldn't segfault your app)

Why?

There's a few libraries out there that wrap git cli commands, parsing the output and such. This is a perfectly acceptable solution. Node-gitteh provides first-class support to work with a git repository on a low level, and does not require git.git (and its myriad of dependencies) to be installed in the server environment.

The documentation is currently outdated. We're working on a new version currently for the new 0.17.x version of gitteh. The Old pre-0.17.x documentation can be found here. Instead, you should visit examples dir in the repo to see examples of 0.17.x usage.

License

Gitteh is available under the MIT License. See the LICENSE file for more information.

Contributing

Contributions are very welcome. Please feel free to fork this project and hack on it. Go ahead and check out the issues tab to see what needs to be done! Go on! Do it!

Building

git clone https://github.com/libgit2/node-gitteh
cd node-gitteh && npm install

Happy hacking!