Rust Crates.io

gix is a command-line interface (CLI) to access git repositories. It's written to optimize the user-experience, and perform as good or better than the canonical implementation.

Furthermore it provides an easy and safe to use API in the form of various small crates for implementing your own tools in a breeze. Please see 'Development Status' for a listing of all crates and their capabilities.

asciicast

Development Status

Please note that from 2020-09-17, the development speed will be reduced greatly. I will do my best to create at least one commit per day ramp it up from there to eventually arrive at a new baseline velocity. It will be lower than what it was before, and I hope 1/2 to 2/3 of that will be realistic.

This is entirely unrelated to the project and I still can't wait to use gitoxide on a daily basis once the first high-level commands become available.

gitoxide (CLI)

git-object

git-odb

git-url

git-protocol

git-packetline

git-transport

git-index

git-commitgraph

git-config

git-repository

git-bundle

git-ref

git-index

git-diff

git-features

git-tui

Stress Testing

Ideas for Demos

Installation

Binary Release

sh curl -LSfs https://raw.githubusercontent.com/Byron/gitoxide/main/ci/install.sh | \ sh -s -- --git Byron/gitoxide --crate gix-max-termion

See the releases section for manual installation and various alternative builds that are slimmer or smaller, depending on your needs, for Linux, MacOS and Windows.

Cargo

cargo is the Rust package manager which can easily be obtained through rustup. With it, you can build your own binary effortlessly and for your particular CPU for additional performance gains.

```

The default installation, 'max'

cargo install gitoxide

On linux, it's a little faster to compile the termion version, which also results in slightly smaller binaries

cargo install gitoxide --no-default-features --features max-termion

For smaller binaries and even faster build times that are traded for a less fancy CLI implementation, use lean

or lean-termion respectively.

cargo install gitoxide --no-default-features --features lean ```

Usage

Once installed, there are two binaries:

Project Goals

Non-Goals

Roadmap to Future

Roadmap to 1.0

Provide a CLI to for the most basic user journey:

Cargo features guide

Cargo uses feature toggles to control which dependencies are pulled in, allowing users to specialize crates to fit their usage. Ideally, these should be additive. This guide documents which features are available for each of the crates provided here and how they function.

gitoxide

The top-level command-line interface.

There are convenience features, which combine common choices of the above into one name

git-features

A crate to help controlling which capabilities are available from the top-level crate that uses gitoxide-core or any other gitoxide crate that uses git-features. All feature toggles are additive.

git-transport

Serialization Support

What follows is feature toggles to control serialization of all public facing simple data types.

Plumbing vs Porcelain

Both terms are coming from the git implementation itself, even though it won't necessarily point out which commands are plumbing and which are porcelain. The term plumbing refers to lower-level, more rarely used commands that complement porcelain by being invoked by it or by hand for certain use cases. The term porcelain refers to those with a decent user experience, they are primarily intended for use by humans.

In any case, both types of programs must self-document their capabilities using through the --help flag.

From there, we can derive a few rules to adhere to unless there are good reasons not to:

Plumbing

Porcelain

Shortcomings

Credits

License

This project is licensed under either of

at your option.

Fun facts