工作记录 + AI 周报生成 - 让 AI 工具(Claude Code/Codex/Codebuddy) 都能调用的工作助手
Project description
worklog-ai — 工作记录 + AI 周报生成
让 Claude Code、Codex、Codebuddy 等 AI 工具能直接调用的工作助手 CLI。
功能
- 📝 自然语言记录:每天在
notes/YYYY-MM-DD.txt随手记工作 - 🤖 AI 生成周报/日报:基于本周/今日记录自动生成结构化报告
- 🖥️ CLI + 对话双模式:既能交互,也能脚本调用
- 🔌 AI 工具友好:subprocess 可直接调用,返回纯文本结果
安装
方式 1:从 PyPI 安装(推荐)
pip install worklog-ai
方式 2:从源码安装
git clone https://github.com/yourname/worklog-ai
cd worklog-ai
pip install -e .
安装后即可使用 todo 命令。
快速开始
1. 配置 AI(首次使用)
todo config --key sk-你的deepseek-key --provider deepseek
# 或交互式:
todo config
2. 记录工作
todo add "完成了用户登录模块开发"
todo add "修复了3个P0 bug"
todo open # 用记事本打开今日笔记
3. 生成报告
todo report weekly # 本周周报
todo report daily # 今日日报
todo report weekly -d 2026-06-17 # 指定日期所在周
todo report weekly -q # 只输出报告内容(去掉元信息)
CLI 完整指令
| 命令 | 作用 |
|---|---|
todo add "内容" |
添加工作记录 |
todo add "内容" -d 2026-06-20 |
记录到指定日期 |
todo list |
列出所有笔记 |
todo view 2026-06-24 |
查看某天内容 |
todo open |
用记事本打开今日笔记 |
todo report weekly |
生成本周周报 |
todo report daily |
生成今日日报 |
todo report monthly |
生成本月月报 |
todo report weekly -q |
只输出报告(适合 AI 消费) |
todo config |
交互式配置 |
todo config --key sk-xxx |
命令行设置 key |
todo config --show |
显示当前配置 |
todo chat |
进入对话模式 |
让 AI 工具调用
Claude Code / Codex / Cursor 等
直接通过 subprocess 调用:
import subprocess
# 记录工作
subprocess.run(["todo", "add", "完成了用户登录模块"])
# 生成周报
result = subprocess.run(["todo", "report", "weekly", "-q"], capture_output=True, text=True)
weekly_report = result.stdout
Shell 方式
# 读取周报内容
WEEKLY=$(todo report weekly -q)
# 把内容发给 AI
echo "$WEEKLY" | claude
AI 提供方支持
| Provider | 价格 | 中文支持 | 备注 |
|---|---|---|---|
| DeepSeek | 极便宜 | ⭐⭐⭐ | 推荐 |
| OpenAI | 中 | ⭐⭐ | 需翻墙 |
| 通义千问 | 免费额度 | ⭐⭐⭐ | 国内 |
| 智谱 GLM | 免费额度 | ⭐⭐⭐ | 国内 |
| 自定义 | - | - | 兼容 OpenAI API |
数据存放
~/.worklog-ai/ (或当前目录的 notes/, reports/)
├── config.json
├── notes/YYYY-MM-DD.txt
└── reports/周报_xxx.md
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
worklog_ai-0.1.1.tar.gz
(10.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file worklog_ai-0.1.1.tar.gz.
File metadata
- Download URL: worklog_ai-0.1.1.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
65a39fb71194bb30bef3f87b596c47dc08a899d2337d094bde3addc52c1ad9b5
|
|
| MD5 |
d5437f68c75f262aa01872526f34ef9b
|
|
| BLAKE2b-256 |
9a95e2ae14647c59f95287d071c2022f787df0d2014154a33dc47465d2421c78
|
File details
Details for the file worklog_ai-0.1.1-py3-none-any.whl.
File metadata
- Download URL: worklog_ai-0.1.1-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
00bcb14407a0b9bbc8920af67a1ca176344dcdf6fe8bca94074829fa7df8058e
|
|
| MD5 |
3d29e7cd3662ec77b501953c2827a4f7
|
|
| BLAKE2b-256 |
a9b5c2b15774f20e891e2bb0ca889453497fd60f8a9940f367a7e32c441311a1
|