This is a solid tool. To make the README truly "pro-tier," we should focus on visual hierarchy, feature highlights, and clearer technical specifications. Since it's built in pure C, thatβs a huge selling point (speed and portability) that we should emphasize.
Here is a revamped version of your README.
π git-recall
git-recall is your personal standup assistant. Built in pure C with zero dependencies, it provides a lightning-fast summary of what you and your team have accomplished over any timeframe.
Installation β’ Usage β’ Troubleshooting β’ Contributing
β¨ Features
- Zero Dependencies: No Python, Node.js, or heavy runtimes. Just
git and a C compiler.
- Flexible Scopes: Quickly pivot between daily, weekly, monthly, or yearly summaries.
- Multipliers: Look back $N$ number of days or weeks with simple flags.
- Native File Export: Built-in support for logging summaries to text files.
- Blazing Fast: Written in C for near-instant execution even in massive monorepos.
π Install
Windows (Winget)
winget install Ammaar.git-recall
Ubuntu / Debian (PPA)
sudo add-apt-repository ppa:ammaar-apt/git-recall
sudo apt update && sudo apt install git-recall
Build from Source
Perfect for macOS or other Linux distros.
git clone https://github.com/AmmaarBakshi/git-recall
cd git-recall
make
sudo make install
π Usage
The basic syntax is git recall [range] [multiplier].
Quick Scopes
| Command | Description |
|---|
git recall | Defaults to the last 7 days |
git recall --day | See today's progress |
git recall --week | Summary of the last week |
git recall --month | Summary of the last month |
git recall --year | The "Year in Review" view |
Lookback Multipliers
Need to see the last 3 days or 2 months? Just add the number:
git recall --day -3 # Last 3 days
git recall --month -2 # Last 2 months
Exporting Reports
# Append/Write to an existing file
git recall --month > recall.txt
# Force create a new file and write
git recall --month > -mk recall.txt
π₯ Example Output
ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
git recall β Last Week (since 2026-04-04)
ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
2026-04-11
448e66e git-recall 0.1.0 : the base version @ 19:41 AmmaarBakshi
ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Total commits: 1
ββββββββββββββββββββββββββββββββββββββββββββββββββββββ
π§ Windows Encoding Fix
If you see garbled characters like ΞΓΆΓ instead of smooth lines β, your PowerShell session isn't using UTF-8.
The Permanent Fix:
- Open your profile:
notepad $PROFILE
- Paste:
[Console]::OutputEncoding = [System.Text.Encoding]::UTF8
- Restart PowerShell.
> [!TIP]
> For the best experience, use Windows Terminal. It handles Unicode natively without any extra configuration.
β οΈ Error Reference
| Message | Solution |
|---|
Not a git repository... | Run the command inside a folder initialized with git init. |
Unknown option: --xyz | Check git recall --help for valid flags. |
Expected filename after '>' | Ensure you provide a path (e.g., > report.txt). |
Cannot open file 'x' | Check folder permissions or if the file is locked by another app. |
π‘ License
Distributed under the MIT License. See LICENSE for more information.
Created by AmmaarBakshi