git-visualizer is a command-line interface (CLI) tool built in Go to visualize Git repository data. It provides several interactive features, such as commit heatmaps, contributor statistics, and more, to help developers understand their Git history and collaboration trends.
- Commit Heatmap: View a heatmap showing commit activity over time (daily, weekly, monthly).
- Contributor Statistics: See top contributors for a selected time range (week/month).
- Interactive Navigation: Navigate through commit data using arrow keys.
- Export Options: Export commit heatmap and contributor stats to CSV, JSON, or text files.
- Easy Setup: Install and run the tool with minimal configuration.
- Go: Make sure you have Go installed. You can download it from here.
- Git: Ensure that Git is installed and configured on your machine.
-
Clone the repository:
git clone https://github.com/<your-username>/git-visualizer.git
-
Navigate to the project directory:
cd git-visualizer -
Install dependencies:
go mod tidy
-
Build the project:
go build
-
Run the CLI tool:
./gitviz
-
Visualize Branches
To list all branches in your Git repository and highlight current branch:
gitviz .
If you'd like to contribute or learn more about how this project is built, check out the development section.
To build the CLI tool from source, run the following:
go buildFeel free to fork the repository and create new features. Open an issue to discuss your ideas or submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
- Go: The core programming language for this project.
- go-git: A Git library in Go for interacting with Git repositories.
- Bubble Tea: A Go package for building interactive terminal UIs.
- Cobra: A Go library for building command-line applications.
If you would like to contribute to this project, feel free to fork the repository and submit pull requests. If you find any bugs or have feature requests, please open an issue.