work-summarizer

work-summarizer is a TypeScript CLI that turns local Git history into polished work summaries. Just oint it at any repo, choose a time window, and get a structured, AI-generated report — categorised by feature, fix, refactor, test, chore, and more.

Full documentation →

What It Does

• Scans commits for a configurable window (24h, 2d, 1w, …) and generates a stand-up-ready summary with Gemini
• Filters noise — lock files, binaries, build output, and configurable excludes
• Enriches reports with Linear issue metadata when commit messages reference tickets
• Detects commits that need documentation follow-up and produces a reviewable task list
• Triggers, polls, and summarises Mintlify documentation deployments
• Exports Markdown and styled HTML reports; supports scheduled daily runs
• Launches a local web UI for reports, run controls, config, and Mintlify management

Quick Start

npm install -g work-summarizer
work-summary config init          # set your Gemini API key
work-summary doctor               # verify setup
work-summary run --since 24h --no-edit
work-summary ui                   # open the web UI at http://localhost:7331

Architecture

Report Generation Flow

flowchart TD
  A["CLI: work-summary run"] --> B["Load configuration"]
  B --> C["Read git commits"]
  C --> D["Normalize diffs and categorize commits"]
  D --> E["Generate summary with Gemini"]
  E --> F{"--with-linear?"}
  F -->|Yes| G["Fetch Linear issue metadata"]
  F -->|No| H["Skip Linear enrichment"]
  G --> I["Detect doc-impact signals"]
  H --> I
  I --> J["Render report Markdown"]
  J --> K{"Editor review enabled?"}
  K -->|Yes| L["Open report in $EDITOR"]
  K -->|No| M["Use generated report"]
  L --> N["Export report"]
  M --> N
  N --> O["Write .md / .html files"]

Loading

Configuration Resolution

flowchart TD
  A["Built-in defaults"] --> F["Merged config"]
  B["~/.work-summary/config.json"] --> F
  C[".work-summary.json (repo-local)"] --> F
  D["~/.work-summary/.env + ./.env"] --> E["process.env vars"]
  E --> F
  F --> G["Runtime config"]

Loading

Requirements

• Node.js >= 18
• Git available in PATH
• Gemini API key (free tier available)

Documentation

The full reference — all commands, flags, configuration options, integration guides, and development notes — lives at:

https://Vedant1202.github.io/work-summarizer/

npm package →

License

MIT