⚡ GitHub Work Summory

AI-powered CLI tool that summarizes your GitHub repositories — perfect for resumes, portfolios, and developer reflections.

✨ Features

• Intelligent Summaries: Uses Vercel AI SDK to generate structured project summaries.
• Support for Local AI: Compatible with LM Studio, OpenRouter, and any OpenAI-compatible API.
• Session Management: Logs into GitHub once, saves session automatically.
• Interactive CLI: Beautiful, prompt-based terminal interface.
• Multi-Repo Processing: Select multiple repositories at once to summarize in batch.
• Quick Summary Mode: Instantly summarize a public repository by passing its URL.

🚀 Quick Start

git clone <repository-url>
cd work-summory
pnpm install
cp .env.example .env
# Edit .env with your AI API base URL and key
pnpm start

🔧 Configuration

The tool uses the @ai-sdk/openai-compatible provider. Edit your .env file to point to your desired model provider:

For LM Studio:

AI_BASE_URL=http://localhost:1234/v1
AI_API_KEY=lm-studio
AI_MODEL=default

For OpenRouter:

AI_BASE_URL=https://openrouter.ai/api/v1
AI_API_KEY=your_openrouter_key
AI_MODEL=meta-llama/llama-3-8b-instruct:free

📖 Usage

Run pnpm start (or npx github-work-summory) to open the main menu:

1. 🔐 Authentication: Login to GitHub, logout, or switch accounts. Session is preserved.
2. 📊 Summarize My Repos: Loads your GitHub profile, lets you select repos via checkboxes, and generates a batch JSON summary.
3. 🔗 Quick Summary: Enter a public repository URL to summarize it without needing to log in.

📄 Output Format

The CLI saves generated summaries into the ./summaries/ directory as Summary_YYYY-MM-DD_HHmmss.json.

{
  "projectName": "github-work-summory",
  "description": "AI-powered CLI tool that summarizes your GitHub repositories.",
  "summary": "A Node.js CLI application that automates the generation of project summaries...",
  "technologies": ["Node.js", "Puppeteer", "Vercel AI SDK"],
  "projectType": "CLI Tool",
  "complexity": "intermediate",
  "resumeBulletPoints": [
    "Built a Node.js CLI tool with Puppeteer for automated GitHub session handling",
    "Integrated the Vercel AI SDK to generate structured summaries for developer portfolios"
  ]
}

🤝 Contributing

Issues and Pull Requests are welcome!

📝 License

MIT License