git-recap
Requirements

Requirements

git-recap is built to be as lightweight and dependency-free as possible. It relies heavily on standard tools already present in most developer environments.

System Prerequisites

  • 1
    Bash

    The core CLI logic expects a standard UNIX-like shell environment (macOS, Linux, or WSL).

  • 2
    Git

    A local installation of Git. Specifically, git-recap relies heavily on git log and internal Git config parsing.

Troubleshooting Author Matching

The most common issue users face is running git-recap and seeing an empty summary. 99% of the time, this happens because git-recap doesn't know who "you" are.

By default, git-recap automatically filters commits matching the author email or name configured in your global Git settings. Ensure these are set correctly:

# Verify your current config
$ git config --global user.email
$ git config --global user.name

# Set them if they are missing
$ git config --global user.email "you@example.com"
$ git config --global user.name "Your Name"

If you commit under multiple emails across different repositories (e.g., a personal email and a work email), git-recap might miss some commits. You can easily override the author check by passing your name directly:

# Match any commit where the author contains "Jane"
$ git-recap --author "Jane"

Prefer reading on GitHub? Source code and contributing notes live in the repository.