Git 中文文档
Build Status

go-gitis 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-gitaims to be fully compatible with git, all the porcelainoperations are implemented to work exactly as gitdoes.

gitis a humongous project with years of development by thousands of contributors, making it challenging for go-gitto implement all the features. You can find a comparison of go-gitvs gitin the compatibility documentation.

Installation


The recommended way to install go-gitis:

  1. ``` go
  2. import "github.com/go-git/go-git/v5" // with go modules enabled (GO111MODULE=on or outside GOPATH)
  3. import "github.com/go-git/go-git" // with go modules disabled
  4. ```

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

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

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

  10. CheckIfError(err)
  11. ```

Outputs:

  1. ``` sh
  2. Counting objects: 4924, done.
  3. Compressing objects: 100% (1333/1333), done.
  4. Total 4924 (delta 530), reused 6 (delta 6), pack-reused 3533

  6. ```

In-memory example


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

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

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

  10. CheckIfError(err)

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

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

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

  23. // ... just iterates over the commits, printing it
  24. err = cIter.ForEach(func(c *object.Commit) error {
  25. fmt.Println(c)
  26. return nil
  27. })
  28. CheckIfError(err)
  29. ```

Outputs:

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

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

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

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

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

  18. ```

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