go-git module - github.com/avdkp/go-git

README ¶

go-git logo

go-git is a highly extensible git implementation library written in pure Go.

It can be used to manipulate git repositories at low level (plumbing) or high level (porcelain), through an idiomatic Go API. It also supports several types of storage, such as in-memory filesystems, or custom implementations, thanks to the Storer interface.

It's being actively developed since 2015 and is being used extensively by Keybase, Gitea or Pulumi, and by many other libraries and tools.

Project Status

After the legal issues with the src-d organization, the lack of update for four months and the requirement to make a hard fork, the project is now back to normality.

The project is currently actively maintained by individual contributors, including several of the original authors, but also backed by a new company, gitsight, where go-git is a critical component used at scale.

Comparison with git

go-git aims to be fully compatible with git, all the porcelain operations are implemented to work exactly as git does.

git is a humongous project with years of development by thousands of contributors, making it challenging for go-git to implement all the features. You can find a comparison of go-git vs git in the compatibility documentation.

Installation

The recommended way to install go-git is:

import "github.com/avdkp/go-git" // with go modules enabled (GO111MODULE=on or outside GOPATH)
import "github.com/go-git/go-git" // with go modules disabled

Examples

Please note that the CheckIfError and Info functions used in the examples are from the examples package just to be used in the examples.

Basic example

A basic example that mimics the standard git clone command

// Clone the given repository to the given directory
Info("git clone https://github.com/go-git/go-git")

_, err := git.PlainClone("/tmp/foo", false, &git.CloneOptions{
    URL:      "https://github.com/go-git/go-git",
    Progress: os.Stdout,
})

CheckIfError(err)

Outputs:

Counting objects: 4924, done.
Compressing objects: 100% (1333/1333), done.
Total 4924 (delta 530), reused 6 (delta 6), pack-reused 3533

In-memory example

Cloning a repository into memory and printing the history of HEAD, just like git log does

// Clones the given repository in memory, creating the remote, the local
// branches and fetching the objects, exactly as:
Info("git clone https://github.com/go-git/go-billy")

r, err := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{
    URL: "https://github.com/go-git/go-billy",
})

CheckIfError(err)

// Gets the HEAD history from HEAD, just like this command:
Info("git log")

// ... retrieves the branch pointed by HEAD
ref, err := r.Head()
CheckIfError(err)


// ... retrieves the commit history
cIter, err := r.Log(&git.LogOptions{From: ref.Hash()})
CheckIfError(err)

// ... just iterates over the commits, printing it
err = cIter.ForEach(func(c *object.Commit) error {
	fmt.Println(c)
	return nil
})
CheckIfError(err)

Outputs:

commit ded8054fd0c3994453e9c8aacaf48d118d42991e
Author: Santiago M. Mola <santi@mola.io>
Date:   Sat Nov 12 21:18:41 2016 +0100

    index: ReadFrom/WriteTo returns IndexReadError/IndexWriteError. (#9)

commit df707095626f384ce2dc1a83b30f9a21d69b9dfc
Author: Santiago M. Mola <santi@mola.io>
Date:   Fri Nov 11 13:23:22 2016 +0100

    readwriter: fix bug when writing index. (#10)

    When using ReadWriter on an existing siva file, absolute offset for
    index entries was not being calculated correctly.
...

You can find this example and many others in the examples folder.

Contribute

Contributions are more than welcome, if you are interested please take a look to our Contributing Guidelines.

License

Apache License Version 2.0, see LICENSE

Directories ¶

Path	Synopsis
_examples
azure_devops
branch
checkout
clone
clone/auth/basic/access_token
clone/auth/basic/username_password
clone/auth/ssh
commit
context
custom_http
find-if-any-tag-point-head
log
ls
ls-remote
merge_base
open
progress
pull
push
remotes
revision
sha256
showcase
submodule
tag
tag-create-push
cli
go-git
config Package config contains the abstraction of multiple config files	Package config contains the abstraction of multiple config files
git A highly extensible git implementation in pure Go.	A highly extensible git implementation in pure Go.
internal
revision Package revision extracts git revision from string More information about revision : https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html	Package revision extracts git revision from string More information about revision : https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html
url
plumbing package plumbing implement the core interfaces and structs used by go-git	package plumbing implement the core interfaces and structs used by go-git
cache
color
filemode
format/commitgraph Package commitgraph implements encoding and decoding of commit-graph files.	Package commitgraph implements encoding and decoding of commit-graph files.
format/config Package config implements encoding and decoding of git config files.	Package config implements encoding and decoding of git config files.
format/diff
format/gitattributes
format/gitignore Package gitignore implements matching file system paths to gitignore patterns that can be automatically read from a git repository tree in the order of definition priorities.	Package gitignore implements matching file system paths to gitignore patterns that can be automatically read from a git repository tree in the order of definition priorities.
format/idxfile Package idxfile implements encoding and decoding of packfile idx files.	Package idxfile implements encoding and decoding of packfile idx files.
format/index Package index implements encoding and decoding of index format files.	Package index implements encoding and decoding of index format files.
format/objfile Package objfile implements encoding and decoding of object files.	Package objfile implements encoding and decoding of object files.
format/packfile Package packfile implements encoding and decoding of packfile format.	Package packfile implements encoding and decoding of packfile format.
format/pktline Package pktline implements reading payloads form pkt-lines and encoding pkt-lines from payloads.	Package pktline implements reading payloads form pkt-lines and encoding pkt-lines from payloads.
hash package hash provides a way for managing the underlying hash implementations used across go-git.	package hash provides a way for managing the underlying hash implementations used across go-git.
object Package object contains implementations of all Git objects and utility functions to work with them.	Package object contains implementations of all Git objects and utility functions to work with them.
object/commitgraph Package commitgraph provides an interface for efficient traversal over Git commit graph either through the regular object storage, or optionally with the index stored in commit-graph file (Git 2.18+).	Package commitgraph provides an interface for efficient traversal over Git commit graph either through the regular object storage, or optionally with the index stored in commit-graph file (Git 2.18+).
protocol/packp
protocol/packp/capability Package capability defines the server and client capabilities.	Package capability defines the server and client capabilities.
protocol/packp/sideband Package sideband implements a sideband mutiplex/demultiplexer	Package sideband implements a sideband mutiplex/demultiplexer
revlist Package revlist provides support to access the ancestors of commits, in a similar way as the git-rev-list command.	Package revlist provides support to access the ancestors of commits, in a similar way as the git-rev-list command.
storer Package storer defines the interfaces to store objects, references, etc.	Package storer defines the interfaces to store objects, references, etc.
transport Package transport includes the implementation for different transport protocols.	Package transport includes the implementation for different transport protocols.
transport/client Package client contains helper function to deal with the different client protocols.	Package client contains helper function to deal with the different client protocols.
transport/file Package file implements the file transport protocol.	Package file implements the file transport protocol.
transport/git Package git implements the git transport protocol.	Package git implements the git transport protocol.
transport/http Package http implements the HTTP transport protocol.	Package http implements the HTTP transport protocol.
transport/http/internal/test
transport/internal/common Package common implements the git pack protocol with a pluggable transport.	Package common implements the git pack protocol with a pluggable transport.
transport/server Package server implements the git server protocol.	Package server implements the git server protocol.
transport/ssh Package ssh implements the SSH transport protocol.	Package ssh implements the SSH transport protocol.
transport/ssh/internal/test
transport/test Package test implements common test suite for different transport implementations.	Package test implements common test suite for different transport implementations.
storage
filesystem Package filesystem is a storage backend base on filesystems	Package filesystem is a storage backend base on filesystems
filesystem/dotgit https://github.com/git/git/blob/master/Documentation/gitrepository-layout.txt	https://github.com/git/git/blob/master/Documentation/gitrepository-layout.txt
memory Package memory is a storage backend base on memory	Package memory is a storage backend base on memory
test
transactional Package transactional is a transactional implementation of git.Storer, it demux the write and read operation of two separate storers, allowing to merge content calling Storage.Commit.	Package transactional is a transactional implementation of git.Storer, it demux the write and read operation of two separate storers, allowing to merge content calling Storage.Commit.
utils
binary Package binary implements sintax-sugar functions on top of the standard library binary package	Package binary implements sintax-sugar functions on top of the standard library binary package
diff Package diff implements line oriented diffs, similar to the ancient Unix diff command.	Package diff implements line oriented diffs, similar to the ancient Unix diff command.
ioutil Package ioutil implements some I/O utility functions.	Package ioutil implements some I/O utility functions.
merkletrie Package merkletrie provides support for n-ary trees that are at the same time Merkle trees and Radix trees (tries).	Package merkletrie provides support for n-ary trees that are at the same time Merkle trees and Radix trees (tries).
merkletrie/filesystem
merkletrie/index
merkletrie/internal/frame
merkletrie/internal/fsnoder Package fsnoder allows to create merkletrie noders that resemble file systems, from human readable string descriptions.	Package fsnoder allows to create merkletrie noders that resemble file systems, from human readable string descriptions.
merkletrie/noder Package noder provide an interface for defining nodes in a merkletrie, their hashes and their paths (a noders and its ancestors).	Package noder provide an interface for defining nodes in a merkletrie, their hashes and their paths (a noders and its ancestors).
sync

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL