https://github.com/riezebosch/gitviz

🔬 Visualize the directed acyclic graph that is your repository!
https://github.com/riezebosch/gitviz

dag education git graph visualization

Last synced: 3 months ago
JSON representation

🔬 Visualize the directed acyclic graph that is your repository!

• Host: GitHub
• URL: https://github.com/riezebosch/gitviz
• Owner: riezebosch
• License: mit
• Created: 2019-09-11T06:34:37.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-06-13T13:02:04.000Z (over 1 year ago)
• Last Synced: 2024-06-20T09:16:39.436Z (5 months ago)
• Topics: dag, education, git, graph, visualization
• Language: Shell
• Homepage: https://riezebosch.github.io/gitviz
• Size: 2.49 MB
• Stars: 9
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - riezebosch/gitviz - 🔬 Visualize the directed acyclic graph that is your repository! (Shell)

README

        
## gitviz

![test](https://github.com/riezebosch/gitviz/workflows/test/badge.svg)

`gitviz` is a tool designed for educational purposes to visualize the Git repository in real time, providing a graphical representation of the blobs, trees, and commits that make up the [git data structure](https://eagain.net/articles/git-for-computer-scientists/).

[![graph](img/graph.png)https://riezebosch.github.io/gitviz/](https://riezebosch.github.io/gitviz/)

### Key Features

- Real-time visualization of Git repository

- Graphical representation of blobs, trees, commits, and references (branches, tags, or HEAD)

- An educational tool for understanding Git's data structure

### Installation

You can install `gitviz` by following these steps:

1. Open a terminal and navigate to the root of your repository.

```sh

#!/bin/bash

set -e

os=$(uname)

arch=$(uname -m)

case $arch in

    aarch64|arm64)

        arch="arm64" 

        ;;

    x86_64|amd64)

        arch="amd64"

        ;;

    *)

        echo "$arch not supported by this script"

        exit 1

        ;;

esac

curl -L -o gitviz "https://github.com/riezebosch/gitviz/releases/latest/download/gitviz_${os}_${arch}"

chmod +x gitviz

sudo mv gitviz /usr/local/bin/gitviz

```

Alternatively, you can run the following command to install `gitviz` directly:

```sh

curl -sSL https://riezebosch.github.io/gitviz/install.sh | sh

```

### Usage

To use `gitviz`, navigate to the root of your repository in a terminal and run the following command:

```sh

gitviz

```

and use `CTRL+C` to stop it when done.

You can also run `gitviz` in the background by appending an ampersand (`&`) to the command:

```sh

gitviz &

```

To stop the process when running in the background, you can use the `kill` command with the appropriate job number. For example, if the job number is `1`, you can use the following command:

```sh

kill %1

```

By using `gitviz`, you will gain valuable insights into the structure of your Git repository in real time, with different colors representing commits, trees, blobs, and references.

---

This [README.md](./README.md) was peer-reviewed by [ChatGPT](https://chat.openai.com/).