lumencode 0.4.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,271 @@
1
+ <div align="center">
2
+ <img src="doc/logo.png" alt="LumenCode" width="520">
3
+ </div>
4
+
5
+
6
+ <p align="center">
7
+ <a href="https://www.npmjs.com/package/lumencode"><img src="https://img.shields.io/npm/v/lumencode.svg?style=flat-square&color=cb3837" alt="npm version"></a>
8
+ <a href="https://www.npmjs.com/package/lumencode"><img src="https://img.shields.io/npm/dm/lumencode.svg?style=flat-square&color=cb3837" alt="npm downloads"></a>
9
+ <a href="LICENSE"><img src="https://img.shields.io/npm/l/lumencode.svg?style=flat-square&color=blue" alt="license"></a>
10
+ <a href="https://nodejs.org/"><img src="https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg?style=flat-square" alt="Node.js"></a>
11
+ </p>
12
+
13
+ <p align="center">
14
+ 支持 <b>Claude Code · Codex · OpenCode</b> 三大 AI 编码工具 · 600+ 模型定价 · AI 贡献度归因 · 一键飞书/钉钉周报
15
+ </p>
16
+
17
+ <p align="center">
18
+ <a href="README_EN.md">English</a> · <a href="#命令用法">命令</a> · <a href="#常见问题">FAQ</a> · <a href="#更新日志">更新日志</a>
19
+ </p>
20
+ ---
21
+
22
+ ## 它解决什么问题?
23
+
24
+ > 「这周 AI 帮你写了多少代码?」「订阅这些工具值不值?」—— 与其每周手算,不如一条命令搞定。
25
+
26
+ | 场景 | 用 lumencode 解决 |
27
+ |------|----------------------|
28
+ | **写周报** | 选周报 → 点「工作汇报 → 复制」→ 粘贴飞书/钉钉。**3 秒搞定。** |
29
+ | **证明 AI ROI** | 「本周 67% 提交有 AI 参与,AI 辅助新增 4,200 行,费用 $12.5」**有数据,有底气。** |
30
+ | **理解使用习惯** | 哪个项目用得最多?哪个模型最费 Token?什么时段是编码高峰?**一目了然。** |
31
+ | **追踪 AI 成本** | 内置 **600+ 模型定价**(含 GLM、Kimi、Qwen、DeepSeek 等),自动算出等效 API 花销 |
32
+
33
+ ---
34
+
35
+ ## 3 秒上手
36
+
37
+ ```bash
38
+ # 全局安装
39
+ npm install -g lumencode
40
+ lumencode serve # 启动 Web 服务,自动打开浏览器
41
+
42
+ # 或零安装直接使用
43
+ npx lumencode serve
44
+ ```
45
+
46
+ **零配置启动** —— 自动检测 `~/.claude`、`~/.codex`、OpenCode 日志目录,从会话里推导项目路径。
47
+
48
+ ---
49
+
50
+ ## 产品亮点
51
+
52
+ | 亮点 | 说明 |
53
+ |------|------|
54
+ | 🌐 **三工具统一** | Claude Code / Codex / OpenCode 数据全自动汇总,左侧标签一键切换 |
55
+ | 🤖 **AI 贡献度量化** | 识别 `Co-Authored-By: Claude` 等签名,多层归因引擎量化 AI 在你代码中的实际占比 |
56
+ | 📝 **自然语言工作汇报** | 详报/简报一键生成,支持标准 Markdown / 飞书 / 钉钉三种格式,每个板块附诊断解读 |
57
+ | 💰 **精确费用估算** | 600+ 模型本地定价(含 GLM/Kimi/Qwen/DeepSeek)+ Portkey API 兜底,未知模型不计费而非乱算 |
58
+ | 📦 **零配置开箱即用** | 首次运行自动检测工具目录、推导项目路径 |
59
+ | 🔍 **数据钻取** | 点击任意图表下钻明细,从汇总数据到具体会话/提交一气呵成 |
60
+ | 📈 **趋势与洞察** | 周报/月报附峰值日识别、连续活跃分析、工具使用五类分布(编辑/阅读/执行/规划/研究) |
61
+ | 🌙 **暗色模式** | 亮/暗主题一键切换,全图表自适配 |
62
+
63
+ ---
64
+
65
+ ## 产品截图
66
+
67
+ ### 多工具汇总视图
68
+
69
+ > 全工具数据汇总,AI 贡献占比、Token 消耗、费用、活跃时段、模型分布、场景拆分一屏掌握。
70
+
71
+ ![全量汇总](doc/全量Ai工具汇总报告.png)
72
+
73
+ ### 单工具报告
74
+
75
+ > 切换左侧标签即可单独查看任一工具的数据。
76
+
77
+ <table>
78
+ <tr>
79
+ <td><img src="doc/claude_code工具使用报告.png" alt="Claude Code" width="400"></td>
80
+ <td><img src="doc/codex使用报告.png" alt="Codex" width="400"></td>
81
+ </tr>
82
+ <tr>
83
+ <td align="center"><b>Claude Code</b></td>
84
+ <td align="center"><b>OpenAI Codex</b></td>
85
+ </tr>
86
+ <tr>
87
+ <td><img src="doc/opencode使用报告.png" alt="OpenCode" width="400"></td>
88
+ <td></td>
89
+ </tr>
90
+ <tr>
91
+ <td align="center"><b>OpenCode</b></td>
92
+ <td></td>
93
+ </tr>
94
+ </table>
95
+
96
+ ### 场景分析 & 模型分布
97
+
98
+ > 按工作类型分类(编码 / 测试 / 调试 / 文档 / 审查 / 规划),还能下钻看每个模型的具体 Token 用量。
99
+
100
+ <table>
101
+ <tr>
102
+ <td><img src="doc/工作类型分布_匹配示例.png" alt="场景分析" width="400"></td>
103
+ <td><img src="doc/模型使用分布_具体用量.png" alt="模型分布" width="400"></td>
104
+ </tr>
105
+ <tr>
106
+ <td align="center">工作类型分布(含匹配关键词示例)</td>
107
+ <td align="center">模型使用分布(含具体 Token 用量)</td>
108
+ </tr>
109
+ </table>
110
+
111
+ ### 工作汇报 · 一键生成可直接发布的周报
112
+
113
+ > 自然语言段落式汇报,覆盖 Token / 费用 / AI 贡献度 / 项目亮点 / 代码产出,每个板块附洞察解读。
114
+
115
+ - **详报** —— 完整数据 + 洞察解读 + 板块编号,适合周报、月报
116
+ - **简报** —— 3-5 句话核心摘要,适合日报或群消息
117
+ - **多平台格式** —— 标准 Markdown / 飞书 / 钉钉,一键切换
118
+
119
+ <table>
120
+ <tr>
121
+ <td><img src="doc/工作汇报_详报.png" alt="工作汇报-详报" width="400"></td>
122
+ <td><img src="doc/工作汇报_简报.png" alt="工作汇报-简报" width="400"></td>
123
+ </tr>
124
+ <tr>
125
+ <td align="center"><b>详报</b></td>
126
+ <td align="center"><b>简报</b></td>
127
+ </tr>
128
+ </table>
129
+
130
+ ### 暗色模式
131
+
132
+ > 全图表配色自适配,长时间阅读不伤眼。
133
+
134
+ ![暗色模式](doc/暗色模式.png)
135
+
136
+ ---
137
+
138
+ ## 命令用法
139
+
140
+ ```bash
141
+ lumencode <命令> [周期] [日期] [选项]
142
+ ```
143
+
144
+ | 命令 | 说明 |
145
+ |------|------|
146
+ | `serve` | 启动 Web 服务(默认端口 4567) |
147
+ | `report` | 生成命令行报告(默认命令) |
148
+ | `init` | 初始化配置文件 |
149
+
150
+ | 周期 | 说明 |
151
+ |------|------|
152
+ | `daily` | 日报(默认) |
153
+ | `weekly` | 周报(自动计算所在周) |
154
+ | `monthly` | 月报(自动计算所在月) |
155
+
156
+ ### 常用示例
157
+
158
+ ```bash
159
+ # Web 模式(推荐)
160
+ lumencode serve
161
+
162
+ # 命令行日报
163
+ lumencode report daily
164
+ lumencode report daily 2026-05-15
165
+
166
+ # 周报 / 月报
167
+ lumencode report weekly
168
+ lumencode report monthly 2026-05-01
169
+
170
+ # 只统计指定项目
171
+ lumencode report daily --projects D:/fzwork,E:/play/idea
172
+
173
+ # 一键生成可发布的工作汇报
174
+ lumencode report daily --work # 详报
175
+ lumencode report daily --work --brief # 简报
176
+ lumencode report weekly --work
177
+ ```
178
+
179
+ ---
180
+
181
+ ## 配置
182
+
183
+ v0.4.0 起支持 Claude Code、Codex、OpenCode 三种工具,**首次运行自动检测**已安装工具的日志目录与项目路径。
184
+
185
+ 如需自定义,点击 Web 页面右上角设置按钮在线修改。
186
+
187
+ | 配置项 | 说明 |
188
+ |--------|------|
189
+ | Claude 日志目录 | Claude Code 数据目录(含 `projects/` 子目录),默认 `~/.claude` |
190
+ | Codex 日志目录 | Codex 数据目录(含 `sessions/` 子目录),默认自动检测 |
191
+ | OpenCode 日志目录 | OpenCode 数据目录,默认自动检测 |
192
+ | 启用工具 | 指定启用哪些工具,默认全部已检测到的工具 |
193
+ | 本地项目路径 | 关联的 Git 仓库路径,用于代码提交统计与 AI 贡献度归因 |
194
+ | 排除项目 | 不希望统计的项目名称 |
195
+ | 场景关键词 | 工作类型分类关键词 JSON |
196
+
197
+ ### 模型定价数据
198
+
199
+ - **本地表**:内置 590 个来自 [Portkey-AI/models](https://github.com/Portkey-AI/models) 的厂商原命名定价
200
+ - **别名映射**:内置 28 条权威覆盖,把 `glm-5.1` / `kimi-for-coding` 等中转服务别名定向到正确定价
201
+ - **API 兜底**:未命中的新模型自动调用 Portkey 免费 API,成功结果缓存到 `data/pricing-cache.json`
202
+ - **失败降级**:API 不可用时该模型按 0 计费,不影响其他模型与报告生成
203
+
204
+ ---
205
+
206
+ ## 常见问题
207
+
208
+ | 问题 | 解决方案 |
209
+ |------|----------|
210
+ | 浏览器显示「暂无数据」 | 首次启动会引导配置;如已跳过,点击右上角设置按钮 |
211
+ | Windows 下日志目录不存在 | 默认路径为 `C:\Users\<用户名>\.claude`,确认该目录下有 `projects/` 子目录 |
212
+ | 端口 4567 被占用 | 设置环境变量:`set LUMENCODE_PORT=8080 && lumencode serve` |
213
+ | 找不到 Git 统计数据 | v0.2.0+ 已自动从会话 `cwd` 推导项目路径,仍未识别时可在设置中手动指定 |
214
+ | 费用显示 $0 | 该模型未在定价表中,可临时联网让 API 兜底,或在 `data/pricing.json` 的 `overrides` 中添加 `aliasOf` 别名 |
215
+
216
+ ---
217
+
218
+ ## 环境要求
219
+
220
+ - Node.js >= 18.0.0
221
+ - 已安装 Claude Code / Codex / OpenCode 中至少一个,并产生过会话日志
222
+
223
+ ---
224
+
225
+ ## 更新日志
226
+
227
+ ### v0.4.0 (2026-05-22) — 多工具统一平台
228
+
229
+ 从 Claude Code 单工具报告升级为 AI 编码全栈分析平台。
230
+
231
+ - **多工具支持** — 新增 OpenAI Codex CLI 和 OpenCode 解析器,三工具数据自动汇总
232
+ - **工具版本检测** — 自动读取各工具版本号显示在侧边栏
233
+ - **AI 归因引擎** — 多层置信度(显式签名 / Session 强关联 / 文件重叠),支持跨天提交匹配和按工具维度过滤
234
+ - **600+ 模型定价** — 集成 [Portkey-AI/models](https://github.com/Portkey-AI/models) 数据库,覆盖 OpenAI/Anthropic/Google/中国厂商;API 兜底未知模型;失败时不计费而非乱算
235
+ - **工作汇报洞察** — 每个板块新增一句话诊断性解读,不只是数据罗列
236
+ - **工具使用模式** — 工具调用从简单排行改为五类分布统计(编辑/阅读/执行/规划/研究)
237
+ - **时间趋势** — 周报/月报新增日维度活跃趋势分析(峰值日、连续活跃、趋势方向)
238
+ - **动态编号** — 汇报板块按实际数据动态编号,不再出现跳号
239
+ - **场景分类扩展** — 新增 Codex/OpenCode/Serena MCP 工具的场景映射
240
+ - **UI 优化** — AI 归因板块重设计、工具主题色(Claude 橙、Codex 绿、OpenCode 紫)、暗色模式细节修复
241
+ - **工作汇报修复** — 暗色模式切换不再误切回主报告页
242
+
243
+ ### v0.3.0 (2026-05-19)
244
+
245
+ - 工作汇报新增飞书、钉钉格式支持,详报/简报两种输出模式
246
+ - 修复刷新布局跳动,优化 Markdown 渲染与暗色主题
247
+ - AI 贡献度置信度评分和文件级指标计算改进
248
+
249
+ ### v0.2.0 (2026-05-17) — Git 深度分析
250
+
251
+ 新增 AI 辅助提交检测、贡献度指标、Conventional Commit 解析、文件热点 Top 10、Session ↔ Commit 关联、零配置启动。
252
+
253
+ ### v0.1.0 (2026-05-17)
254
+
255
+ 首个正式发布版本。
256
+
257
+ ---
258
+
259
+ ## 支持项目
260
+
261
+ 如果这个工具帮到你,不妨:
262
+
263
+ - **给个 Star** —— 让更多人看到这个工具
264
+ - **提 Issue** —— 报告 Bug 或建议新功能
265
+ - **提 PR** —— 欢迎贡献模型定价、场景关键词、工具适配
266
+
267
+ ---
268
+
269
+ ## 许可证
270
+
271
+ [MIT](LICENSE) © [zhangyaowen](https://github.com/yaowen51888-rich)