/local-git-contributions-visualizer

Command line tool written in Go. It allows developers to scan their local Git repositories and generate a visual contributions graph.

Primary LanguageGoMIT LicenseMIT

local-git-contributions-visualizer

The local-git-contributions-visualizer is a command-line tool written in Go that enables developers to scan their local Git repositories and generate a visual contributions graph. This tool is particularly useful for developers who work with multiple Git services, such as GitHub and GitLab. It allows them to visualize their contributions across both platforms, even in offline or disconnected environments.

Screenshots

git-local-contributions-visualizer

Features

  • Scan local Git repositories and generate a contributions graph.
  • Visualize contributions from Github and Gitlab services.
  • Works offline, making it convenient for use in remote or disconnected environments.

Development

1- To clone the local-git-contributions-visualizer repository, copy and paste the following command:

  git clone https://github.com/abdullah-alaadine/local-git-contributions-visualizer.git

2- To run the tool, execute the following command:

  go run .

3- To build the tool, run the following command:

  go build

Installation

To install the local-git-contributions-visualizer, ensure that you have Go installed on your machine. Then, execute the following command:

  go install github.com/abdullah-alaadine/local-git-contributions-visualizer@latest

Usage

1- Run the local-git-contributions-visualizer executable:

./local-git-contributions-visualizer

2- Enter your Git email address when prompted:

Enter your Git email address: your-email@example.com

3- Enter the folder path to scan for Git repositories:

Enter the folder path to scan for Git repositories: /path/to/repository

Hint

You can use the following command: Perhaps you want to check the email used for git on your machine.

git config --global user.email

Contributions

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

1- Fork the repository.

2- Create a new branch for your feature or bug fix.

3- Make the necessary changes and commit them.

4- Push your changes to your fork.

5- Submit a pull request describing your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.