git-lost-and-found

Git scanning tool designed to find dangling commits.

This tool is designed to be used in conjunction with other git scanning tools that leverage git log to search diffs. git-lost-and-found is designed to find commits that are not reachable by any branch or tag in the repository, and add named references to them. This allows other tools to find these commits and their changes, since once they are reachable by a named reference they will be included in the output of git log --all. Some tools that can be used in conjunction with git-lost-and-found are:

• gitleaks
• trufflehog

Installing

Package manager

Install using homebrew

brew tap bthuilot/tap
brew install bthuilot/tap/git-lost-and-found

Building Locally

The repository can be built using the makefile provided. Requires Go to be installed on the system. Optionally a docker image can be built using the makefile.

# clone the repo
git clone github.com/bthuilot/git-lost-and-found && cd git-lost-and-found
# To build the binary
make build
# Or to build a docker image
make build-docker

Running

# Use the help menu to see what options are available
git-lost-and-found scan --help

Using a docker image

docker run \
  -v /my/repo/path:/repo \
  ghcr.io/bthuilot/git-lost-and-found:latest scan \
  --repo-path /repo -- trufflehog git file://. --no-verification

Scanning an existing repo using gitleaks

# NOTE: gitleaks will have to be installed on the system
# git-lost-and-found is not responsible for installing or configuring gitleaks
git-lost-and-found scan --repo-path "/my/repo/path" -- gitleaks detect .
# OR  git-lost-and-found scan --repo-path "/my/repo/path" -- gitleaks detect {}

Clone and scan a repository with Trufflehog

# NOTE: trufflehog will have to be installed on the system
# git-lost-and-found is not responsible for installing or configuring trufflehog
git-lost-and-found scan --repo-url "https://github.com/torvalds/linux" -- trufflehog git file://. --no-verification
# OR  git-lost-and-found scan --repo-url "https://github.com/torvalds/linux" -- trufflehog git file://{} --no-verification