Git-Email-Extractor

README

Git Email Extractor

A tool to extract email addresses from any git repository. Only dependency is Git on your system. It can process multiple repositories in parallel.

You can find built binaries for mostly every platform in the Releases page. Binaries are built using Github Actions.

Usage

Using Go

go install github.com/Sudo-Ivan/Git-Email-Extractor@latest
git-email-extractor -t <token> -w <workers> -c <contributors> -f <format> -o <output> <repo-url1> [repo-url2 ...]

Using Docker

docker run --rm -v $(pwd)/output:/output ghcr.io/sudo-ivan/git-email-extractor:latest -c https://github.com/user/repo

Using Docker Compose

# Extract emails from a repository
docker-compose run --rm git-email-extractor -c https://github.com/user/repo

# Extract emails and save to output file
docker-compose run --rm git-email-extractor -c -f json -o /output/results.json https://github.com/user/repo

FAQ

Why Git instead of API?

Requiring Git makes it easier to support all types of git platforms, including self-hosted ones. APIs also can change and have rate limits.

Documentation

Overview

Package main implements a tool to extract unique email addresses from Git repositories. It supports multiple repository URLs, concurrent processing, and various output formats. The tool can extract emails from commit authors, committers, and commit messages.

Usage:

git-email-extractor [-t token] [-w workers] [-c] [-f format] [-o output] <repo-url1> [repo-url2 ...]

Flags:

-t string
      GitHub/GitLab token for private repositories
-w int
      Number of worker goroutines (default 4)
-c    Include contributor emails (committers and signed-off-by)
-f string
      Output format (json, csv, txt) (default "txt")
-o string
      Output file (default: stdout)