Gitoxide

<img src="etc/msrv-badge.svg">

gitoxide is an implementation of git written in Rust for developing future-proof applications which strive for correctness and performance while providing a pleasant and unsurprising developer experience.

There are two primary ways to use gitoxide:

1. As Rust library: Use the gix crate as a Cargo dependency for API access.
2. As command-line tool: The gix binary as development tool to help testing the API in real repositories, and the ein binary with workflow-enhancing tools. Both binaries may forever be unstable, do not rely on them in scripts.

Development Status

The command-line tools as well as the status of each crate is described in the crate status document.

For use in applications, look for the gix crate, which serves as entrypoint to the functionality provided by various lower-level plumbing crates like gix-config.

Feature Discovery

Can gix do what I need it to do?

The above can be hard to answer and this paragraph is here to help with feature discovery.

Look at crate-status.md for a rather exhaustive document that contains both implemented and planned features.

Further, the gix crate documentation with the git2 search term helps to find all currently known git2 equivalent method calls. Please note that this list is definitely not exhaustive yet, but might help if you are coming from git2.

What follows is a high-level list of features and those which are planned:

• [x] clone
• [x] fetch
• [ ] push
• [x] blame (plumbing)
• [x] status
• [x] blob and tree-diff
• [ ] merge
  • [x] blobs
  • [x] trees
  • [ ] commits
• [x] commit
  • [ ] hooks
• [x] commit-graph traversal
• [ ] rebase
• [x] worktree checkout and worktree stream
• [ ] reset
• [x] reading and writing of objects
• [x] reading and writing of refs
• [x] reading and writing of .git/index
• [x] reading and writing of git configuration
• [x] pathspecs
• [x] revspecs
• [x] .gitignore and .gitattributes

Crates

Follow linked crate name for detailed status. Please note that all crates follow semver as well as the [stability guide].

Production Grade

• Stability Tier 1

  • gix-lock

• Stability Tier 2

  • gix-tempfile

Stabilization Candidates

Crates that seem feature complete and need to see some more use before they can be released as 1.0. Documentation is complete and was reviewed at least once.

• gix-mailmap
• gix-chunk
• gix-ref
• gix-config
• gix-config-value
• gix-glob
• gix-actor
• gix-hash

Initial Development

These crates may be missing some features and thus are somewhat incomplete, but what's there is usable to some extent.

• usable (with rough but complete docs, possibly incomplete functionality)
  • gix (⬅ entrypoint)
  • gix-object
  • gix-validate
  • gix-url
  • gix-packetline
  • gix-packetline-blocking
  • gix-transport
  • gix-protocol
  • gix-pack
  • gix-odb
  • gix-commitgraph
  • gix-diff
  • gix-traverse
  • gix-features
  • gix-credentials
  • gix-sec
  • gix-quote
  • gix-discover
  • gix-path
  • gix-attributes
  • gix-ignore
  • gix-pathspec
  • gix-index
  • gix-revision
  • gix-revwalk
  • gix-command
  • gix-prompt
  • gix-refspec
  • gix-fs
  • gix-utils
  • gix-hashtable
  • gix-worktree
  • gix-bitmap
  • gix-negotiate
  • gix-filter
  • gix-worktree-stream
  • gix-archive
  • gix-submodule
  • gix-status
  • gix-worktree-state
  • gix-date
  • gix-dir
  • gix-merge
  • gix-shallow
  • gix-error
  • gitoxide-core
• very early (possibly without any documentation and many rough edges)
  • gix-blame
• idea (just a name placeholder)
  • gix-note
  • gix-fetchhead
  • gix-lfs
  • gix-rebase
  • gix-sequencer
  • gix-tui
  • gix-tix
  • gix-bundle
  • gix-fsck

Stress Testing

• [x] Verify huge packs
• [x] Explode a pack to disk
• [x] Generate and verify large commit graphs
• [ ] Generate huge pack from a lot of loose objects

Stability and MSRV

Our [stability gu