Skip to content

git weekly-summary

Generate a weekly summary of git activity and accomplishments.

Usage

bash
git weekly-summary [OPTIONS]
  • Default: Shows both PRs and commits for current week
  • Content filters: Use --pr or --commit to show specific content
  • Date range: Specify custom period with --since and --until
  • Output format: Use --md for markdown file export

Options

OptionDescription
--prInclude Pull Requests in summary
--commitInclude commits in summary
--since <date>Start date (YYYY-MM-DD), defaults to Monday of current week
--until <date>End date (YYYY-MM-DD), defaults to today
--md [filename]Output in Markdown format, optionally specify filename
--statsShow additional statistics

Features

  • Pull Request Analysis: Shows PRs created, merged, and reviewed
  • Commit Analysis: Summarizes commits with message categorization
  • Flexible Output: Console display or markdown file export
  • Statistics: Optional detailed statistics about activity
  • Date Range Flexibility: Can generate summaries for any time period
  • Selective Content: Choose to include PRs only, commits only, or both

Examples

bash
# Show both PRs and commits for current week
git weekly-summary

# Show only PRs for current week
git weekly-summary --pr

# Show only commits for current week
git weekly-summary --commit

# Custom date range with statistics
git weekly-summary --since 2024-08-10 --until 2024-08-16 --stats

# Full markdown report (includes everything)
git weekly-summary --md weekly-report.md

# PRs only with statistics to console
git weekly-summary --pr --stats

Built with VitePress