📋 Work-Report CLI 工具

📖 README markdown

Work-Report CLI

全局工作记录工具：Git 追踪 + 工作笔记 + 日报生成

📌 简介

work-report 是一个命令行工作记录工具，帮助开发者自动追踪 Git 项目提交记录、管理工作笔记，并一键生成日报复制到剪贴板。

✨ 功能特性

• 🎯 Git 项目追踪 - 添加/移除/列出追踪的 Git 项目
• 📝 工作笔记 - 记录每日工作内容，支持增删查
• 📊 日报生成 - 自动聚合 Git 提交和笔记，生成格式化日报
• 📋 一键复制 - 生成的日报自动复制到剪贴板

🚀 快速开始

安装

npm install -g work-report
初始化
安装后会自动执行初始化，创建 .data 目录和 meta.json 配置文件。

📖 使用指南
1. Git 项目追踪
bash
# 添加当前 Git 项目到追踪列表
work-report git add

# 移除当前项目追踪
work-report git remove

# 列出所有追踪的项目
work-report git list

# 清空所有追踪
work-report git clear
2. 工作笔记
bash
# 添加工作笔记
work-report note add "完成了用户登录模块开发"

# 列出所有笔记
work-report note list

# 删除指定序号的笔记
work-report note remove 1
3. 生成日报
bash
# 生成今日日报并复制到剪贴板
work-report report
4. 查看帮助
bash
work-report --help
📁 数据存储
数据存储在用户主目录下的 .data 文件夹中：

.data/
└── meta.json    # 存储 Git 项目列表和工作笔记
🛠️ 技术栈
Node.js - 运行环境
Commander - 命令行框架
FS-Extra - 文件系统操作
Chalk - 终端颜色输出
Copy-Paste - 剪贴板操作
📦 依赖
json
{
  "chalk": "^3.0.0",
  "commander": "^11.1.0",
  "copy-paste": "^2.2.0",
  "fs-extra": "^11.3.4"
}
🔧 开发
bash
# 克隆项目
git clone <repository-url>

# 安装依赖
npm install

# 本地运行
npm run work-report -- <command>
⚠️ 注意事项
确保已安装 Git 并配置 user.name
需要在 Git 项目目录下执行 git add 命令
日报生成基于昨日至今的 Git 提交记录
---