gitpdf

Export your git commit history to a beautifully formatted PDF.

Usage

Run inside any git repository:

# Interactive mode (opens a wizard UI)
npx gitpdf

# CLI mode (skip the UI)
npx gitpdf --author "John" --from 2024-01-01 --to 2024-12-31 --style cyber --theme dark --avatars -o report.pdf

CLI Options

| Option | Description | Default | |--------|-------------|---------| | -a, --author <name> | Filter commits by author | All authors | | --from <date> | Start date (YYYY-MM-DD) | All time | | --to <date> | End date (YYYY-MM-DD) | Now | | -s, --style <style> | standard or cyber | standard | | -t, --theme <theme> | light or dark | light | | -f, --font <font> | figtree, jetbrains-mono, or helvetica | figtree | | -l, --layout <type> | portrait or landscape | portrait | | --date-format <fmt> | date, datetime, or datetime-seconds | date | | --avatars | Show Gravatar profile pictures | Off | | --no-date | Hide commit dates | | | --no-description | Hide commit body/description | | | --no-show-author | Hide author column | | | --no-hash | Hide commit hash column | | | --no-badges | Disable conventional commit badges | | | --no-co-authors | Hide co-authors | | | -o, --output <path> | Output file path | commits.pdf |

Styles

• Standard — editorial layout: left-aligned title, hairline rows, tinted commit-type badges, monospace hashes and dates
• Cyber — terminal-like brutalist aesthetic: square corners, grayscale palette, forced monospace, lowercase labels, dense layout

Both styles support light and dark themes.

Features

• Interactive wizard UI powered by Ink
• Conventional commit badges (feat, fix, chore, docs, etc.)
• Co-author support (parsed from Co-authored-by trailers)
• Gravatar profile pictures for committers
• Two visual styles: Standard and Cyber
• Dark and light themes
• Configurable date format (date only, with time, with seconds)
• Font choices: Figtree, JetBrains Mono, Helvetica
• Portrait or landscape orientation
• Configurable columns (hash, date, author, description)
• Date range and author filtering

Development

bun install
bun run dev

Publishing

bun run pub

This bumps the version (based on conventional commits), builds with tsup, and publishes to npm. Only dist/ and fonts/ are included in the package.