28 releases (18 breaking)
|0.19.0||Aug 28, 2023|
|0.18.0||Apr 2, 2023|
|0.17.0||Jan 10, 2023|
|0.16.0||Jul 28, 2022|
|0.2.2||Mar 25, 2015|
112,842 downloads per month
Used in 129 crates (4 directly)
libgit2 bindings for Rust.
[dependencies] git2 = "0.17.2"
Rust version requirements
git2-rs works with stable Rust, and typically works with the most recent prior stable release as well.
Version of libgit2
Currently this library requires libgit2 1.6.4 (or newer patch versions). The source for libgit2 is included in the libgit2-sys crate so there's no need to pre-install the libgit2 library, the libgit2-sys crate will figure that and/or build that for you.
$ git clone https://github.com/rust-lang/git2-rs $ cd git2-rs $ cargo build
Running tests and handling all of the associated edge cases on every commit
proves tedious very quickly. To automate tests and handle proper stashing and
unstashing of unstaged changes and thus avoid nasty surprises, use the
pre-commit hook found here and place it into the
.git/hooks/ with the name
pre-commit. You may need to add execution
To skip tests on a simple commit or doc-fixes, use
git commit --no-verify.
Building on macOS 10.10+
ssh feature is enabled (and it is by default) then this library depends
on libssh2 which depends on OpenSSL. To get OpenSSL working follow the
openssl crate's instructions.
This project is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in git2-rs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
A crate for using libcurl as a backend for HTTP git requests with git2-rs.
This crate provides one public function,
register, which will register
a custom HTTP transport with libcurl for any HTTP requests made by libgit2.
At this time the
register function is unsafe for the same reasons that
git2::transport::register is also unsafe.
It is not recommended to use this crate wherever possible. The current
libcurl backend used,
curl-rust, only supports executing a request in one
method call implying no streaming support. This consequently means that
when a repository is cloned the entire contents of the repo are downloaded
into memory, and then written off to disk by libgit2 afterwards. It
should be possible to alleviate this problem in the future.
NOTE: At this time this crate likely does not support a
git pushoperation, only clones.