Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlange-42/git-graph
Command line tool to show clear git graphs arranged for your branching model
https://github.com/mlange-42/git-graph
command-line command-line-tool git git-flow git-graph gitlab-flow graph rust
Last synced: 5 days ago
JSON representation
Command line tool to show clear git graphs arranged for your branching model
- Host: GitHub
- URL: https://github.com/mlange-42/git-graph
- Owner: mlange-42
- License: mit
- Created: 2020-12-07T22:40:35.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T09:44:05.000Z (7 months ago)
- Last Synced: 2024-11-30T14:11:33.498Z (12 days ago)
- Topics: command-line, command-line-tool, git, git-flow, git-graph, gitlab-flow, graph, rust
- Language: Rust
- Homepage:
- Size: 210 KB
- Stars: 565
- Watchers: 4
- Forks: 22
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - mlange-42/git-graph - Command line tool to show clear git graphs arranged for your branching model (Rust)
README
# git-graph
[](https://github.com/mlange-42/git-graph/actions/workflows/tests.yml)
[](https://github.com/mlange-42/git-graph)
[](https://crates.io/crates/git-graph)
[](https://github.com/mlange-42/git-graph/blob/master/LICENSE)
A command line tool to visualize Git history graphs in a comprehensible way, following different branching models.
The image below shows an example using the [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) branching model for a comparison between graphs generated by git-graph (far left) versus other tools and Git clients.
> GitFlow was chosen for its complexity, while any other branching model is supported, including user-defined ones.
Decide for yourself which graph is the most comprehensible. :sunglasses:
If you want an **interactive Git terminal application**, see [**git-igitt**](https://github.com/mlange-42/git-igitt), which is based on git-graph.
## Features
* View structured graphs directly in the terminal
* Pre-defined and custom branching models and coloring
* Different styles, including ASCII-only (i.e. no "special characters")
* Custom commit formatting, like with `git log --format="..."`
## Installation
**Pre-compiled binaries**
1. Download the [latest binaries](https://github.com/mlange-42/git-graph/releases) for your platform
2. Unzip somewhere
3. *Optional:* add directory `git-graph` to your `PATH` environmental variable
**Using `cargo`**
In case you have [Rust](https://www.rust-lang.org/) installed, you can install with `cargo`:
```
cargo install git-graph
```
## Usage
**For detailed information, see the [manual](docs/manual.md)**.
For basic usage, run the following command inside a Git repository's folder:
```
git-graph
```
> Note: git-graph needs to be on the PATH, or you need use the full path to git-graph:
>
> ```
> C:/path/to/git-graph/git-graph
> ```
**Branching models**
Run git-graph with a specific model, e.g. `simple`:
```
git-graph --model simple
```
Alternatively, set the model for the current repository permanently:
```
git-graph model simple
```
**Get help**
For the full CLI help describing all options, use:
```
git-graph -h
git-graph --help
```
For **styles** and commit **formatting**, see the [manual](docs/manual.md).
## Custom branching models
Branching models are configured using the files in `APP_DATA/git-graph/models`.
* Windows: `C:\Users\\AppData\Roaming\git-graph`
* Linux: `~/.config/git-graph`
* OSX: `~/Library/Application Support/git-graph`
File names of any `.toml` files in the `models` directory can be used in parameter `--model`, or via sub-command `model`. E.g., to use a branching model defined in `my-model.toml`, use:
```
git-graph --model my-model
```
**For details on how to create your own branching models see the manual, section [Custom branching models](docs/manual.md#custom-branching-models).**
## Limitations
* Summaries of merge commits (i.e. 1st line of message) should not be modified! git-graph needs them to categorize merged branches.
* Supports only the primary remote repository `origin`.
* Does currently not support "octopus merges" (i.e. no more than 2 parents)
* On Windows PowerShell, piping to file output does not work properly (changes encoding), so you may want to use the default Windows console instead
## Contributing
Please report any issues and feature requests in the [issue tracker](https://github.com/mlange-42/git-graph/issues).
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.