https://github.com/containerscrew/gitrack
Scan local git repositories
https://github.com/containerscrew/gitrack
cargo git git-repository git-tracker rust rust-project
Last synced: 4 months ago
JSON representation
Scan local git repositories
- Host: GitHub
- URL: https://github.com/containerscrew/gitrack
- Owner: containerscrew
- License: agpl-3.0
- Created: 2024-08-15T10:44:10.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-16T21:04:08.000Z (5 months ago)
- Last Synced: 2025-01-05T05:16:18.683Z (5 months ago)
- Topics: cargo, git, git-repository, git-tracker, rust, rust-project
- Language: Rust
- Homepage:
- Size: 1.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gitrack
**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)
- [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)
# 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 |  |
| Release | [](https://github.com/containerscrew/gitrack/releases/latest) |
| Code |  |
| CI - Build | [](https://github.com/containerscrew/gitrack/actions/workflows/build.yml) |
| CI - Release | [](https://github.com/containerscrew/gitrack/actions/workflows/release.yml) |
| CI - Test | [](https://github.com/containerscrew/gitrack/actions/workflows/test.yml) |
| Meta | [](https://github.com/pre-commit/pre-commit) [](/LICENSE) |
| Codecov | [](https://codecov.io/gh/containerscrew/gitrack) |
| Downloads | [](https://somsubhra.github.io/github-release-stats/?username=containerscrew&repository=gitrack) |
# Supported Platforms
| Arch | ARM64 | AMD64 |
|--------|-------|-------|
| darwin | ✅ | ✅ |
| linux | ✅ | ✅ |
# Installation
## Install latest version
```shell
$ cargo install gitrack
```
Or the binary:
```shell
$ curl --proto '=https' --tlsv1.2 -sSfL https://raw.githubusercontent.com/containerscrew/gitrack/main/install.sh | sh
```
## Install specific release
```shell
cargo install [email protected]
```
```shell
$ curl --proto '=https' --tlsv1.2 -sSfL https://raw.githubusercontent.com/containerscrew/gitrack/main/install.sh | sh -s -- -v "v0.8.0"
```
# Uninstall
```bash
sudo rm /usr/local/bin/gitrack
```
If you installed the cli using cargo:
```shell
cargo uninstall gitrack
```
# Usage
## Help
```bash
gitrack --help
Scan git repositories in your file system
Usage: gitrack [OPTIONS]
Options:
-p, --path Folder path you want to scan for git untracked files [default: /home/dcr]
-w, --workers Number of threads to use for scanning repositories [default: 5]
-d, --diff Show differences between changed files
-e, --exclude-dir ... 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
## Scan untracked repositories
## Scan untracked repositories with verbose
## Diff files
## Exclude directories
# TODO
* Implement git commit scan for sensitive data using regex. Just for fun. Like gitleaks does.
# License
[License](./LICENSE)