https://github.com/libgit2/node-gitteh
Node.js bindings for libgit2
https://github.com/libgit2/node-gitteh
Last synced: 3 months ago
JSON representation
Node.js bindings for libgit2
- Host: GitHub
- URL: https://github.com/libgit2/node-gitteh
- Owner: libgit2
- License: mit
- Created: 2011-03-07T16:43:56.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2015-01-20T02:46:07.000Z (over 10 years ago)
- Last Synced: 2025-03-29T01:09:56.719Z (3 months ago)
- Language: JavaScript
- Homepage: http://libgit2.github.com
- Size: 2.44 MB
- Stars: 430
- Watchers: 12
- Forks: 56
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Gitteh
[](https://travis-ci.org/libgit2/node-gitteh) [](https://npmjs.org/package/gitteh) [](https://david-dm.org/libgit2/node-gitteh) [](https://david-dm.org/libgit2/node-gitteh#info=devDependencies)
## 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](http://libgit2.github.com) 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](http://libgit2.github.com/node-gitteh/docs/index.html). Instead, you should visit [`examples`](https://github.com/libgit2/node-gitteh/tree/master/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!