Skip to content

josetseph/work-reporting

Repository files navigation

Monthly Work Report

Generates a professional monthly work report from your GitHub commits using any OpenAI-compatible LLM API (local or remote — Ollama, LM Studio, OpenAI, etc.).

Setup

npm install
cp .env.example .env.local
# fill in .env.local with your values
npm run dev

Open http://localhost:3000.

Environment variables

See .env.example for all required and optional variables.

Variable Required Description
GITHUB_PAT Yes Classic GitHub Personal Access Token with repo read scope
GITHUB_USERNAME Yes GitHub username whose commits to fetch
GITHUB_ORG Yes GitHub organisation to search within
LLM_ENABLED No Set to true to show the AI report section (default: false)
LLM_BASE_URL No Base URL of your LLM's OpenAI-compatible API (e.g. http://localhost:1234)
LLM_API_KEY No API key if required by your provider (leave blank for local models)
LLM_MODEL No Model name to use (e.g. gpt-4o, llama3, google/gemma-4-e4b)

Usage

  1. Pick the month and year.
  2. Click Fetch commits — your commits across all org repos are listed grouped by day.
  3. Optionally add context in the text area (e.g. "Focus on the infrastructure work").
  4. Click Write report to stream a day-by-day report from your LLM.
  5. Copy the report or save as PDF.

License

MIT

About

LLM Assisted Monthly Work Report Generator from GitHub Commits

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors