daily-commit-summary
v2.4.0
Published
Generate daily work reports from git commits using AI
Maintainers
Readme
Daily Commit Summary
Generate daily work reports from git commits using AI. Create detailed reports for project management tools or brief summaries for time tracking apps.
Installation
Global install (recommended for CLI usage)
# Using npm
npm install -g daily-commit-summary
# Using pnpm (recommended)
pnpm add -g daily-commit-summary
# Using yarn
yarn global add daily-commit-summaryRun Locally (Development)
# Clone the repository
git clone [email protected]:aneudysamparo/daily-commit-summary.git
cd daily-commit-summary
# Install dependencies
pnpm install
# Run the CLI
node index.js [options]
# Or link globally
pnpm link --globalConfiguration
Global Config (Recommended)
Run the interactive setup to configure your API keys and defaults:
ds --initThis creates a config file at ~/.daily-commit-summary.json.
To view current config:
ds --configPer-Project Config
Create a .env file in your project root:
API_PROVIDER=openai
OPENAI_API_KEY=sk-your-key
OPENAI_MODEL=gpt-4o-mini
DEFAULT_REPORT=allCLI Overrides
Overrides take precedence (CLI flags > .env > Global Config).
ds --api perplexity --key pplx-xxxUsage
ds [options]Options
| Option | Alias | Description |
|--------|-------|-------------|
| --path | -p | Path to git repository (default: current) |
| --date | -d | Date YYYY-MM-DD (default: today) |
| --report | -r | Report type: all, full, summary |
| --api | -a | Provider: openai, perplexity |
| --model | -m | Model name override |
| --copy | | Copy report to clipboard |
| --init | | Interactive setup |
| --config | | Show current config |
| --help | -h | Show help |
Shortcuts
ds→ Daily summary (standard)dcs→ Daily summary + copy to clipboard (equivalent tods --copy)
Examples
# Generate report for today
ds
# Generate for specific date and path
ds -p ~/projects/client-app -d 2026-01-05
# Only summary, copied to clipboard
dcs -r summary
# Use Perplexity instead of OpenAI temporarily
ds --api perplexity --model llama-3.1-sonar-largeFeatures
- Multi-Provider AI: Support for OpenAI and Perplexity.
- Flexible Reporting: Full detailed reports or concise summaries.
- Configurable: Global config, per-project
.env, or CLI flags. - Clipboard Integration:
dcsshortcut for instant pasting.
How It Works
- Fetches git commits for the target date.
- Sends commits to the selected AI model with a structured prompt.
- Generates a formatted markdown report.
- Optionally copies output to clipboard.
Requirements
- Node.js >= 16.0.0
- Git installed and available in path.
- API Key (OpenAI or Perplexity).
Contributing
See CONTRIBUTING.md.
License
MIT
