workpilot
v0.2.1
Published
AI-powered CLI for generating Git-based daily/weekly/monthly reports and commit messages.
Maintainers
Readme
workpilot
Stop writing daily reports manually.
Language: This page is English. Switch to 中文.
workpilot is an AI CLI that reads your Git history and code changes and generates:
- daily work reports
- weekly summaries
- monthly reviews
- clean commit messages
All directly from your code.
wp dayExample output:
Today's Work Summary:
1. Shipped user login API and tightened error handling
2. Fixed edge cases in checkout flow
3. Improved list rendering performance
4. Added order state machine and integration testsDemo
A typical workflow during development:
End of the day:
wp dayBefore committing:
wp commitWeekly review:
wp weekInstead of manually writing reports, your Git history becomes your work log.
Why workpilot
Turn Git history into reports
Generate daily, weekly, and monthly work summaries automatically.
Better commit messages
Generate structured commit messages from Git diffs.
Built for terminal workflows
Runs anywhere Git runs:
- terminal
- scripts
- CI pipelines
Bring your own API key
No subscription required. You only pay the API cost.
Install
npm install -g workpilotThe CLI exposes two command names:
workpilot
wpThey are identical. Examples in this README use the shorter command:
wpCheck help:
wp --helpQuick Start
1. Set API key
OpenAI:
export OPEN_AI_API_KEY=sk-xxxDeepSeek:
export DEEPSEEK_API_KEY=sk-xxxOptional provider selection:
export AI_PROVIDER=openaiProvider selection logic:
- If
AI_PROVIDERis set, workpilot always usesAI_PROVIDER. - If
AI_PROVIDERis not set, workpilot picks the first available key in this order:DEEPSEEK_API_KEYOPEN_AI_API_KEY
To persist across terminals, add these lines to your shell config:
- bash →
~/.bashrc - zsh →
~/.zshrc
2. Generate today's report
wp dayDone.
Commands
Reports
Generate work summaries from Git history.
wp day
wp week
wp month
wp day --lang zhSpecify time selection:
# Daily
wp day last # yesterday
wp day 2026-03-10 # exact day
wp day --from 2026-03-01 --to 2026-03-10
# Weekly
wp week last # last full week (Mon–Sun)
wp week 2026-W16
# Monthly
wp month last # last full month
wp month MarControl output language:
wp day --lang zh
wp week --lang enCommit messages
Generate commit messages from Git diffs.
wp commitPreview without committing:
wp commit --no-commitClipboard helpers
Append copy to copy output to clipboard.
wp day copy
wp week copy
wp commit copyCopy the last generated report:
wp copyIntegrations
Workpilot can open common collaboration tools after generating reports.
wp day --dingtalk # wp day --dingding
wp week --feishu
wp month --wecom # wp month --weixin
--dingtalkopens DingTalk after report generation.--dingdingis an alias of--dingtalk.--wecomopens WeCom after report generation.--weixinis an alias of--wecom.
Supported integrations:
- DingTalk
- Feishu
- WeCom
The report content is also copied to clipboard for quick paste.
Example
Generate a report and copy it:
wp day 2026-03-10 copyGenerate a commit message:
wp commitCost
Very low.
Typical usage:
- ~100 daily reports often cost well under $0.10
- depends on model and token usage
You only pay the API provider.
No subscription required.
Configuration
Optional environment variables.
| Variable | Description |
| ---------------- | -------------------------- |
| AI_PROVIDER | openai or deepseek |
| OPEN_AI_API_KEY | OpenAI API key |
| OPEN_AI_MODEL | OpenAI model |
| OPEN_AI_BASE | OpenAI-compatible base URL |
| DEEPSEEK_API_KEY | DeepSeek API key |
| DEEPSEEK_MODEL | DeepSeek model |
Selection priority:
AI_PROVIDER(if set) overrides auto selection.- If
AI_PROVIDERis not set, the first available key is used:DEEPSEEK_API_KEYOPEN_AI_API_KEY
Requirements
- Node.js >= 18
- Local Git repository
Documentation
Full CLI reference:
docs/CLI-COMMANDS.mdFeedback
Issues and suggestions are welcome.
GitHub Issues:
https://github.com/gaozhixiaopengpeng/work-pilot/issues
Project repository:
https://github.com/gaozhixiaopengpeng/work-pilot
License
MIT
