# gitrack

<!-- START OF TOC !DO NOT EDIT THIS CONTENT MANUALLY-->
**Table of Contents**  *generated with [mtoc](https://github.com/containerscrew/mtoc)*
- [gitrack](#gitrack)
- [About](#about)
- [Badges](#badges)
- [Supported Platforms](#supported-platforms)
- [Installation](#installation)
  - [Install latest version](#install-latest-version)
  - [Install specific release](#install-specific-release)
  - [Using cargo](#using-cargo)
- [Uninstall](#uninstall)
- [Usage](#usage)
  - [Help](#help)
  - [Scan folders containing git repositories](#scan-folders-containing-git-repositories)
  - [Scanning for untracked changes (summarized)](#scanning-for-untracked-changes-(summarized))
  - [Scanning for untracked changes (verbose)](#scanning-for-untracked-changes-(verbose))
  - [Diff files for untracked changes](#diff-files-for-untracked-changes)
  - [Control number of workers/threads](#control-number-of-workers/threads)
  - [Exclude directories](#exclude-directories)
- [About threads](#about-threads)
- [Dev](#dev)
  - [pre-commit](#pre-commit)
  - [Local container](#local-container)
- [Examples](#examples)
  - [Scan folder containing git repositories](#scan-folder-containing-git-repositories)
  - [Scan untracked repositories](#scan-untracked-repositories)
  - [Scan untracked repositories with verbose](#scan-untracked-repositories-with-verbose)
  - [Diff files](#diff-files)
  - [Exclude directories](#exclude-directories)
- [TODO](#todo)
- [License](#license)
<!-- END OF TOC -->

# About

Scan git repositories in your file system. Find untracked changes, diff files, and more.

Easy and simple. This tool was created just for fun and to practice Rust.

Implemented features:

* Scan for untracked changes in git repositories.
* Scan `.git` folders in your file system (with multithreads).
* Diff files for untracked changes.


# Badges

|              |                                                                                                                                                                                                                                                    |
|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Language     | ![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)                                                                                                                                             |
| Release      | [![Release](https://img.shields.io/github/release/containerscrew/gitrack)](https://github.com/containerscrew/gitrack/releases/latest)                                                                                                              |
| Code         | ![Code Size](https://img.shields.io/github/languages/code-size/containerscrew/gitrack)                                                                                                                                                             |
| CI - Build   | [![Build](https://github.com/containerscrew/gitrack/actions/workflows/build.yml/badge.svg)](https://github.com/containerscrew/gitrack/actions/workflows/build.yml)                                                                                 |
| CI - Release | [![Build](https://github.com/containerscrew/gitrack/actions/workflows/release.yml/badge.svg)](https://github.com/containerscrew/gitrack/actions/workflows/release.yml)                                                                             |
| CI - Test    | [![Build](https://github.com/containerscrew/gitrack/actions/workflows/test.yml/badge.svg)](https://github.com/containerscrew/gitrack/actions/workflows/test.yml)                                                                                   |
| Meta         | [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![License - MIT](https://img.shields.io/github/license/containerscrew/gitrack)](/LICENSE) |
| Codecov      | [![Codecov](https://codecov.io/gh/containerscrew/gitrack/graph/badge.svg?token=4AI2U4PX4V)](https://codecov.io/gh/containerscrew/gitrack)                                                                                                          |
| Downloads    | [![Downloads](https://img.shields.io/github/downloads/containerscrew/gitrack/total.svg?logo=github)](https://somsubhra.github.io/github-release-stats/?username=containerscrew&repository=gitrack)                                                 |

# Supported Platforms

| Arch   | ARM64 | AMD64 |
|--------|-------|-------|
| darwin | ✅     | ✅   |
| linux  | ✅     | ✅   |

# Installation

## Install latest version

```shell
curl --proto '=https' --tlsv1.2 -sSfL https://raw.githubusercontent.com/containerscrew/gitrack/main/install.sh | sh
```

## Install specific release

```shell
curl --proto '=https' --tlsv1.2 -sSfL https://raw.githubusercontent.com/containerscrew/gitrack/main/install.sh | sh -s -- -v "v0.8.0"
```

## Using cargo

* **[Install Cargo](https://rustup.rs/)**

Open a terminal and run:

```shell
git clone https://github.com/containerscrew/gitrack
cd gitrack
make install
```

# Uninstall

```bash
sudo rm /usr/local/bin/gitrack
```

With cargo:

```shell
make uninstall
```

# Usage

## Help

```bash
gitrack --help

Scan git repositories in your file system

Usage: gitrack [OPTIONS]

Options:
  -p, --path <PATH>               Folder path you want to scan for git untracked files [default: /home/dcr]
  -w, --workers <WORKERS>         Number of threads to use for scanning repositories [default: 5]
  -d, --diff                      Show differences between changed files
  -e, --exclude-dir <EXCLUDE>...  Exclude directories to scan
  -u, --check-untracked           Only show repositories with untracked files
  -v, --verbose                   Print verbose output
  -h, --help                      Print help
  -V, --version                   Print version
```

## Scan folders containing git repositories

```bash
gitrack -p /home/elliot # home will be always the default values if -p is not provided
```

## Scanning for untracked changes (summarized)

```bash
gitrack -p /home/elliot -u
```

## Scanning for untracked changes (verbose)

```bash
gitrack -p /home/elliot -u -v
```

## Diff files for untracked changes

```bash
gitrack -p /home/elliot -u -d # without -u, -d will not work
```

## Control number of workers/threads

```bash
gitrack -p /home/elliot -u -w 6
```

## Exclude directories

```bash
gitrack -p /home/elliot -e "/home/elliot/.cache" -e "/home/elliot/.local" -u -w 6
```

# About threads

> The use of threads is not really necessary in this type of tools, unless you have a very large file/folder system. Adding threads does not mean always better performance. I have included them in order to practice their use.

# Dev

## pre-commit

```bash
cd gitrack/
pre-commit install
```

## Local container

```bash
cd gitrack/
docker run -it --rm -w /app -h gitrack --name gitrack -v $PWD:/app docker.io/rust:1.80.1-slim-bullseye
```

# Examples

## Scan folder containing git repositories

![example1](img/example1.png)

## Scan untracked repositories

![example2](img/example2.png)

## Scan untracked repositories with verbose

![example3](img/example3.png)

## Diff files

![example4](img/example4.png)

## Exclude directories

![example5](img/example5.png)

# TODO

* Implement git commit scan for sensitive data using regex. Just for fun. Like gitleaks does.


# License

[License](./LICENSE)