Commands
Summarize local git history as Markdown: by date, as a standup, or as a changelog.
Summarizes local git history as Markdown using git log with field and record separators: no human-format parsing, no network, no AI.
broom recap # last 7 days, grouped by datebroom recap --days 1broom recap --format standup # per author, per daybroom recap --format changelog # Conventional Commit sectionsbroom recap --group-by author # date | author | nonebroom recap --author "Ada" # git --author pattern, case-insensitivebroom recap --merges # include merge commitsbroom recap --limit 200 # cap commits (default 1000)broom recap --output CHANGELOG.md # asks before overwriting (or --yes)broom recap --jsonExample changelog output from a small repository:
# Changelog_2026-11-11 to 2026-11-18 · 6 commits · branch `main`_## Breaking changes- **clean:** re-check files before deleting (`f6a4d2d`)## Features- **clean:** re-check files before deleting (`f6a4d2d`)- add --format standup to recap (`9e9416d`)## Fixes- **env:** ignore runtime-provided variables (`b41750e`)## Performance- cache tsconfig path resolution (`169518f`)| Flag | Default | Description |
|---|---|---|
-d, --days <n> | 7 | How many days back to include. |
-f, --format <format> | markdown | markdown, standup or changelog. |
-g, --group-by <group> | date | Grouping for markdown: date, author or none. |
-a, --author <pattern> | – | Only commits whose author matches. A git author pattern (regular expression), case-insensitive. |
-o, --output <file> | – | Write the Markdown to a file. Asks before overwriting. |
--limit <n> | 1000 | Maximum number of commits. |
--merges | off | Include merge commits. |
-y, --yes | – | Overwrite --output without asking. |
The output only restates commit metadata (subject, hash, author, date). Reverts, merges and breaking changes (feat!: / BREAKING CHANGE:) are recognized. Notes are added for truncated output, shallow clones and uncommitted changes, which are never included. Empty repositories produce an empty summary; outside a repository the command exits 1.
Found a problem in these docs? Open an issue on GitHub.