https://github.com/vedant1202/work-summarizer
A TypeScript CLI and web UI that transforms your local Git history into automated daily stand-up summaries using Gemini AI. Features intelligent noise filtering, Linear issue integration, Mintlify deployment management, and customizable reporting.
https://github.com/vedant1202/work-summarizer
agentic-ai ai ai-tools automation cli developer-tools gemini-ai git linear-app mintlify productivity reporting standup typescript
Last synced: about 1 month ago
JSON representation
A TypeScript CLI and web UI that transforms your local Git history into automated daily stand-up summaries using Gemini AI. Features intelligent noise filtering, Linear issue integration, Mintlify deployment management, and customizable reporting.
- Host: GitHub
- URL: https://github.com/vedant1202/work-summarizer
- Owner: Vedant1202
- License: mit
- Created: 2026-05-18T05:17:04.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-05-24T20:15:21.000Z (about 1 month ago)
- Last Synced: 2026-05-24T21:24:04.828Z (about 1 month ago)
- Topics: agentic-ai, ai, ai-tools, automation, cli, developer-tools, gemini-ai, git, linear-app, mintlify, productivity, reporting, standup, typescript
- Language: TypeScript
- Homepage: https://vedant1202.github.io/work-summarizer/
- Size: 1.43 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# work-summarizer
[](https://www.npmjs.com/package/work-summarizer)
[](https://www.npmjs.com/package/work-summarizer)
[](LICENSE)
[](https://Vedant1202.github.io/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 →](https://Vedant1202.github.io/work-summarizer/)**
## 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
```bash
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
```mermaid
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"]
```
### Configuration Resolution
```mermaid
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"]
```
## Requirements
- Node.js >= 18
- Git available in `PATH`
- [Gemini API key](https://aistudio.google.com/apikey) (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/](https://Vedant1202.github.io/work-summarizer/)**
**[npm package →](https://www.npmjs.com/package/work-summarizer)**
## License
MIT