NOTE: GEX IS UNFINISHED SOFTWARE. As a result, many features are missing, and the interface can change at any moment.

Git workflow improvement CLI tool inspired by Magit. This project is still under initial development, but I am actively dogfooding it and features should be added relatively quickly.

Primarily, this is a personal project since I recently switched to Neovim from Emacs and miss the simplicity and efficiency of using Magit. However, I do have some general aims, which are subject to change:

• Simple - uncluttered UI.
• Intuitive - it should be easy to learn to use gex.
• Cross platform - primary focus on Linux, but should work well on Windows and MacOS.
• Configurable - certain preferences in gex should be configurable to suit your own workflow.
• Comprehensive* - you should be able to use gex to do everything you can do in git.

* gex supports executing arbitrary git commands with : for when something is not yet available

• Magit port

While it serves as a major inspiration, I am not trying to 1:1 port the behaviour and functionality of Magit.

NOTE: You will need Rust on your system for this installation method.

$ cargo install gex

Gex packages are also maintained by the community in a handful of repositories.

To enter gex simply type gex in console, optionally providing a path.

$ gex

Full usage:

$ gex --help

Git workflow improvement CLI tool inspired by Magit

Usage: gex [OPTIONS] [PATH]

Arguments:
  [PATH]  The path to the repository [default: .]

Options:
  -c, --config-file <PATH>  Path to a config file to use
  -h, --help                Print help
  -V, --version             Print version

Gex will look for a config file in the following places:

Here is an example config.toml:

[options]
auto_expand_files = false
auto_expand_hunks = true
lookahead_lines = 5
truncate_lines = true # `false` is not recommended - see #37
ws_error_highlight = "new" # override git's diff.wsErrorHighlight

# Named colours use the terminal colour scheme. You can also describe your colours
# by RGB "rgb_(r,g,b)" or by Ansi "ansi_(value)".
#
# This example uses a Gruvbox colour theme.
[colors]
foreground = "rgb_(223,191,142)"
background = "rgb_(40,40,40)"
heading = "rgb_(227,168,78)"
hunk_head = "rgb_(125,174,163)"
addition = "rgb_(169,182,101)"
deletion = "rgb_(234,105,98)"
key = "rgb_(169,182,101)"
error = "rgb_(234,105,98)"

A 0.X version increase indicates some change that could reasonably break someone's workflow. This is quite hard to define, so apologies if it does not meet your expectations. Usually this means changing a default setting or redesigning parts of the UI.

A 0.x.Y version increase indicates a change that should not break any workflow - i.e. fixing a bugs or adding features.

Whichever number is increased does not deliberately correlate with the size of the update.

1.0.0 will come when I consider the software to be "finished", subject to small improvements/features or bug fixes. What this means is very subjective, and my own thoughts on this are likely to evolve as the project progresses.

This project is dual-licensed under either:

• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

at your option.

See CONTRIBUTING.md.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.