Getting Started
Welcome to git-recap! This documentation covers everything you need to start generating clean, categorized standup summaries from your Git history in seconds.
Why git-recap?
Writing your daily standup shouldn't be a chore. Manually sifting through `git log`, trying to remember what you worked on, and formatting it for Slack or Notion is tedious.
git-recap automates this process by instantly scanning your repositories, intelligently grouping your commits into categories (like Features, Fixes, or Docs), and outputting a perfectly formatted summary.
Installation
The easiest way to install git-recap on macOS or Linux is via Homebrew:
$ brew tap StackwiseTechnologiesLtd/tools && brew trust StackwiseTechnologiesLtd/tools && brew install git-recapNote: Modern Homebrew requires brew trust for third-party taps. If you prefer to install from source using Rust's cargo, see the GitHub README.
Quick Start
Once installed, navigate to any Git repository on your machine and run:
$ git-recap --todayThis will scan your repository for commits made since midnight and output a categorized summary. If you want to scan multiple repositories at once, you can run the command from a parent directory and it will automatically find all immediate sub-directories containing a `.git` folder!
Explore the Docs
Built-in Modules
See how commits are categorized automatically and how conventional commits are stripped.
Timeframe Handling
Learn how to pass custom dates, use shortcuts like --yesterday, or use environment variables.
API Reference
Read about all available CLI options, flags, and arguments for complete configuration.
Requirements
Ensure your system is configured correctly to get the most accurate commit author matching.