gh-tldr
v1.2.0
Published
Generate a TL;DR summary of your GitHub activity
Maintainers
Readme
gh-tldr
AI-powered TL;DR of your GitHub activity
Stop manually tracking what you did this week. gh-tldr fetches your GitHub activity and uses Claude AI to generate a human-readable summary—perfect for standups, status updates, or weekly reports.
Quick Start
npx gh-tldrThat's it. Follow the prompts.
Features
- 📊 Summarizes PRs, reviews, commits, and issues
- 📈 Tracks lines of code changed (additions/deletions)
- 🤖 Powered by Claude AI for natural language summaries
- 🎯 Custom prompt support for focused summaries
- 🔄 Interactive or scripted mode
- 📝 Multiple output formats (plain text, markdown, slack)
- 🔒 Private repository support
- 🏢 Organization/scope filtering
- 🌍 English and German output
Prerequisites
- Node.js >= 18
- GitHub CLI (
gh) - authenticated - Claude Code (
claude)
brew install gh node
gh auth loginInstallation
The easiest way is npx gh-tldr (no install needed).
git clone https://github.com/yungweng/gh-tldr.git
cd gh-tldr
pnpm install
pnpm build
pnpm link --globalIf you use Aikido Safe-Chain, you may need to bypass it:
# Bash/Zsh
\npx gh-tldr
# Fish
command npx gh-tldrOr add an alias:
# ~/.bashrc or ~/.zshrc
alias gh-tldr='\npx gh-tldr'
# ~/.config/fish/config.fish
alias gh-tldr='command npx gh-tldr'Usage
Interactive Mode
gh-tldr? GitHub username (leave empty for authenticated user)
? Time period › Last 24 hours / Last 7 days / Last 30 days
? Language › English / German
? Summary verbosity › Brief / Normal / Detailed
? Output format › Plain text / Markdown / Slack
? Include private repos? (y/N)
? Filter by scope › All / org-name / username
? Claude model (leave empty for default)
? Any specific focus for the summary? (optional)Direct Mode
gh-tldr [username] [options]| Option | Description |
|--------|-------------|
| -d, --days <n> | Time period in days (default: 1) |
| -e, --english | Output in English (default: German) |
| -f, --format <type> | Output: plain | markdown | slack |
| -v, --verbosity <level> | Summary length: brief | normal | detailed |
| -p, --public-only | Exclude private repositories |
| -o, --orgs <orgs> | Filter by organizations/accounts (comma-separated) |
| -m, --model <model> | Claude model (e.g., haiku, sonnet, opus) |
| -P, --prompt <text> | Custom instructions for Claude |
| -i, --interactive | Force interactive mode |
| -h, --help | Show help |
Examples
# Last 7 days in English
gh-tldr --days 7 --english
# Specific user, public repos only
gh-tldr yungweng --public-only
# Filter by organization
gh-tldr --orgs my-company,my-org
# Custom focus for standup
gh-tldr -P "Focus on bug fixes and blockers"
# Brief summary with Haiku model
gh-tldr --verbosity brief --model haiku
# Markdown output for documentation
gh-tldr --days 30 --format markdownExample Output
tl;dr 28.12.2025
• 3 PRs created (repo-a, repo-b)
• 5 PRs reviewed (repo-c)
• 2 PRs merged (repo-a)
• 1 issue closed (repo-d)
• 12 commits (repo-a, repo-b)
• +1,234 / -567 lines changed (15 files)
Repos: org/repo-a, org/repo-b, org/repo-c, org/repo-d
---
Mainly worked on Feature X. Completed and merged PR "Add user authentication".
Did several code reviews for the team, including the new API endpoint.Development
pnpm dev # Run in dev mode
pnpm build # Build
pnpm typecheck # Type checkContributing
Issues and PRs welcome! See open issues.
Links
Author
Maintained by @yungweng
License
MIT
