This library provides C++/Qt language bindings to libgit2. In large part, it is a port of the libgit2sharp which provided a nice OO object model to work from.
Tip
This project requires Qt 6.
Get the code:
`git clone https://github.com/StevePunak/libgit2qt.git`
- Start Qt Creator
- Open the CMakeLists.txt in the root folder.
- Select a kit to build.
- Build the library
There is a submodules project which includes the library and a program with some examples. This is probably the best way to get started for most people as there is currently no documentation (working on it).
-
Get the code:
git clone https://github.com/StevePunak/Git2QtMains.git -
Get the test repository:
git clone https://github.com/StevePunak/GitTesting.git -
Start Qt Creator
-
Open the CMakeLists.txt in the root folder.
-
Select a kit to build.
-
Build the project
-
Run the example program with the following parameters
auto --local-path /path/to/test-repository/GitTesting
In the debugger, set the command line arguments to point to the test repository you cloned in step 2 as shown.
Here are some simple sample usages:
Repository* repo = Commands::clone("https://github.com/StevePunak/GitTesting.git", "/home/beavis/src/GitTesting");
Supplying credentials and getting progress are performed via callback and are demonstrated in the example code.
Branch branch = _repository->findLocalBranch("master");
if(branch.isNull() == false) {
...
}
StatusEntry::List modified = _repository->status().modified();
if(_repository->stage(modified) == true) {
Signature signature("beavis", "beavis@butthead.com");
Commit commit = _repository->commit("This is my great commmit message", signature, signature);
if(commit.isNull()) {
// handle commit failure
}
}
The main way to ask questions and submit feature requests for now is through discussions.
File bug reports in the normal manner.
I'm going to continue to iterate through my normal git use and add features as I need them. The plan is to fully implement all the features available in libgit2sharp.
Of course, contributions are much appreciated!
As of this writing, the code is very fresh and there are plenty of things to do:
- Better manipulation of remotes
- Windows support for declspecs
- Better submodule support
- CI / CD for nightly builds
- Implement test units (the sample code is intended to be converted to test units)
- Doxygen
Pick something, create a branch and submit a pull request!
The inspiration for this project mainly came from libgit2sharp.
I wanted to create a nice object-oriented git library and a great base for my object model was waiting right there.
Thanks to libgit2 and libgit2sharp for the great foundation to work from.
This code is licensed under the Apache license. Free as in free beer.
Project is in early development but is already useful and being used in my own applications.