rb-daily-report-skill
v1.0.11
Published
A Node.js tool for managing daily reports and generating weekly summaries
Maintainers
Readme
日报总结周报工具 (rb)
一个基于 Node.js 的 npm 插件,用于收集每日日报并自动生成每周周报总结。通过 rb 命令快速管理日报。
功能特性
- 日报管理: 添加、查看、编辑、删除日报
- 周报生成: 根据一周的日报自动生成周报
- 本地存储: 使用 JSON 文件存储数据,安全可靠
- 数据备份: 自动备份数据,防止数据丢失
- 命令行界面: 友好的命令行交互
- 全局命令: 安装后可在任何地方使用
rb命令 - 中文支持: 修复了中文乱码问题,确保中文正常显示
- 版本号查看: 查看当前工具版本
- 帮助信息: 查看详细的使用说明和命令列表
- 统计信息: 查看日报和周报的统计信息
- 数据恢复: 从备份文件恢复数据
- 配置管理: 查看和修改工具配置
- 数据隔离: 不同用户在各自的本地环境中生成和存储日报数据
- 跨平台兼容: 支持 Windows、macOS 和 Linux 操作系统
安装
前提条件
- Node.js 14.0 或更高版本
- npm 6.0 或更高版本
全局安装
npm install -g rb-daily-report-skill本地开发安装
- 克隆或下载本项目到本地
- 进入项目目录
- 运行以下命令安装依赖:
npm install- 链接到全局:
npm link使用方法
命令行接口
添加日报
# 简化格式:直接输入内容(默认使用当天日期)
rb set "今天完成了项目A的开发,修复了几个bug"
# 添加指定日期的日报
rb set --date 2026-04-13 "完成了项目A的开发,修复了几个bug"
# 交互式添加日报(不指定内容)
rb set --date 2026-04-14查看日报
# 查看指定日期的日报
rb view --date 2026-04-13
# 查看当日日报(不指定日期)
rb view编辑日报
# 编辑指定日期的日报
rb edit --date 2026-04-13 --content "完成了项目A的开发,修复了几个bug,优化了性能"
# 交互式编辑日报(不指定内容)
rb edit --date 2026-04-13删除日报
# 删除指定日期的日报
rb delete --date 2026-04-13
# 删除当日日报(不指定日期)
rb delete生成周报
# 生成包含指定日期的周的周报
rb weekly --week 2026-04-13
# 生成包含当日的周的周报(不指定周)
rb weekly查看版本号
# 查看当前工具版本
rb version查看帮助信息
# 查看详细的使用说明和命令列表
rb help查看统计信息
# 查看日报和周报的统计信息
rb stats备份数据
# 手动备份数据
rb backup恢复数据
# 从备份文件恢复数据
rb restore backup-2026-04-13.json配置管理
# 查看所有配置
rb config
# 查看指定配置
rb config language
# 修改配置
rb config language en-US更新工具
# 更新工具到最新版本
rb update数据存储
Windows: 数据存储在
%USERPROFILE%\AppData\Local\rb-daily-report目录下macOS: 数据存储在
~/Library/Application Support/rb-daily-report目录下Linux: 数据存储在
~/.local/share/rb-daily-report目录下日报数据存储在
reports/daily-reports.json文件中周报生成在
reports/目录下,文件名格式为weekly-report-YYYY-MM-DD-YYYY-MM-DD.html数据备份存储在
reports/backups/目录下配置文件存储在
config.json文件中
周报模板
周报模板存储在 templates/weekly-report.ejs 文件中,您可以根据需要修改模板格式。
项目结构
├── package.json # 项目配置和依赖
├── index.js # 主入口文件
├── src/ # 源代码目录
│ ├── skill.js # Skill 核心实现
│ ├── storage.js # 数据存储管理
│ ├── parser.js # 日报解析器
│ ├── summarizer.js # 周报生成器
│ └── utils/ # 工具函数
│ └── date.js # 日期处理工具
├── data/ # 数据存储目录
│ └── reports/ # 日报和周报存储
│ └── backups/ # 数据备份
└── templates/ # 模板目录
└── weekly-report.ejs # 周报模板注意事项
- 请确保 Node.js 版本不低于 14.0
- 首次运行时会自动创建必要的目录结构
- 数据会自动备份,确保数据安全
- 周报生成后会保存在 data/reports 目录下
示例
添加日报示例
node index.js add --date 2026-04-13 --content "完成了项目A的开发,修复了几个bug"
node index.js add --date 2026-04-14 --content "完成了项目B的测试,编写了测试用例"
node index.js add --date 2026-04-15 --content "参加了团队会议,讨论了项目进度"生成周报示例
node index.js weekly --week 2026-04-13生成的周报会包含 2026-04-13 至 2026-04-19 这一周的所有日报内容。
扩展功能
未来计划添加以下功能:
- 支持从其他应用导入日报
- 支持导出为 PDF、Word 等格式
- 支持团队协作,多人日报管理和汇总
- 提供 Web 界面,方便操作
