功能开发

README.md

@@ -1 +1,249 @@
-# devkit-cli
+# devkit-cli
+
+开发者工具包命令行工具 - 一个功能丰富的 CLI 工具，提供系统信息查看、文件批量处理和任务管理功能。
+
+## 技术栈
+
+- **Python** - 核心编程语言
+- **Typer** - 现代化的 CLI 框架
+- **Rich** - 终端美化与表格展示
+- **psutil** - 系统信息获取
+
+## 安装
+
+```bash
+# 克隆或下载项目后，安装依赖
+pip install -r requirements.txt
+```
+
+依赖要求：
+- typer>=0.9.0
+- rich>=13.0.0
+- psutil>=5.9.0
+
+## 快速开始
+
+```bash
+# 查看帮助
+python devkit.py --help
+
+# 查看版本
+python devkit.py --version
+```
+
+## 功能命令
+
+### 1. info - 系统信息查看
+
+查看本机系统信息，包括操作系统、CPU、内存、磁盘等。
+
+```bash
+# 查看系统信息（彩色表格）
+python devkit.py info
+
+# JSON 格式输出
+python devkit.py info --json
+```
+
+**输出内容：**
+- 系统信息：操作系统、版本、处理器、主机名、Python版本
+- CPU 信息：物理/逻辑核心数、频率、使用率
+- 内存信息：总内存、可用内存、已用内存、使用率
+- 磁盘信息：各分区容量、已用、可用、使用率
+
+### 2. file - 文件批量处理
+
+#### file rename - 批量重命名文件
+
+```bash
+# 基本用法
+python devkit.py file rename <目录路径> --prefix <前缀> --start <起始编号>
+
+# 示例：添加前缀并自动编号
+python devkit.py file rename ./photos --prefix "vacation_" --start 1
+
+# 预览模式（不实际执行）
+python devkit.py file rename ./docs --pattern "*.txt" --prefix "doc_" --dry-run
+
+# 完整参数
+python devkit.py file rename ./files \
+  --prefix "file_"      # 文件名前缀 \
+  --start 1             # 起始编号 \
+  --padding 3           # 编号位数（补零） \
+  --pattern "*.jpg"     # 文件匹配模式（glob） \
+  --recursive           # 递归处理子目录 \
+  --lowercase           # 转换为小写 \
+  --uppercase           # 转换为大写 \
+  --dry-run             # 预览模式
+```
+
+#### file list - 列出目录文件
+
+```bash
+# 列出当前目录文件
+python devkit.py file list
+
+# 列出指定目录
+python devkit.py file list ./documents
+
+# 递归列出
+python devkit.py file list ./projects --recursive
+
+# 按模式筛选
+python devkit.py file list ./logs --pattern "*.log"
+```
+
+### 3. todo - 本地任务管理
+
+任务数据存储在 `~/.devkit/todos.json`
+
+#### todo add - 添加任务
+
+```bash
+# 添加简单任务
+python devkit.py todo add "完成任务报告"
+
+# 添加带优先级和标签的任务
+python devkit.py todo add "修复Bug" --priority high --tag work
+
+# 优先级选项：high（高）、medium（中）、low（低）
+```
+
+#### todo list - 查看任务列表
+
+```bash
+# 查看未完成任务
+python devkit.py todo list
+
+# 查看所有任务（包括已完成）
+python devkit.py todo list --all
+
+# 按优先级筛选
+python devkit.py todo list --priority high
+
+# 按标签筛选
+python devkit.py todo list --tag work
+```
+
+#### todo done - 标记任务完成
+
+```bash
+# 标记 ID 为 1 的任务为已完成
+python devkit.py todo done 1
+```
+
+#### todo undo - 取消完成状态
+
+```bash
+# 将 ID 为 1 的任务重置为未完成
+python devkit.py todo undo 1
+```
+
+#### todo delete - 删除任务
+
+```bash
+# 删除 ID 为 1 的任务（会确认）
+python devkit.py todo delete 1
+
+# 强制删除（不确认）
+python devkit.py todo delete 1 --force
+```
+
+#### todo clear - 清空已完成任务
+
+```bash
+# 清空所有已完成任务（会确认）
+python devkit.py todo clear
+
+# 强制清空（不确认）
+python devkit.py todo clear --force
+```
+
+## 使用示例
+
+### 示例 1：查看系统信息
+
+```bash
+$ python devkit.py info
+
+                                系统信息
+┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ 项目            ┃ 值                                                  ┃
+┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ 操作系统        │ Windows                                             │
+│ 系统版本        │ 10.0.19045                                          │
+│ 处理器          │ Intel64 Family 6 Model 190 Stepping 0, GenuineIntel │
+│ Python版本      │ 3.14.3                                              │
+└─────────────────┴─────────────────────────────────────────────────────┘
+...
+```
+
+### 示例 2：批量重命名照片
+
+```bash
+# 1. 先预览
+$ python devkit.py file rename ./vacation --prefix "photo_" --start 1 --dry-run
+
+              重命名预览
+┏━━━━━━━━┳━━━━━━━━━━━━━━┳━━━┳━━━━━━━━━━━━━━┓
+┃ 序号   ┃ 原文件名     ┃ → ┃ 新文件名     ┃
+┡━━━━━━━━╇━━━━━━━━━━━━━━╇━━━╇━━━━━━━━━━━━━━┩
+│ 1      │ IMG_0001.jpg │ → │ photo_001.jpg│
+│ 2      │ IMG_0002.jpg │ → │ photo_002.jpg│
+└────────┴──────────────┴───┴──────────────┘
+
+# 2. 确认后执行
+$ python devkit.py file rename ./vacation --prefix "photo_" --start 1
+
+✓ 重命名完成!
+  成功: 2 个
+```
+
+### 示例 3：任务管理流程
+
+```bash
+# 添加任务
+$ python devkit.py todo add "完成CLI开发" --priority high --tag work
+✓ 任务已添加
+  ID: 1
+  标题: 完成CLI开发
+  优先级: high
+  标签: work
+
+# 查看任务
+$ python devkit.py todo list
+┏━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
+┃  ID  ┃ 状态 ┃ 标题         ┃  优先级  ┃ 标签       ┃ 创建时间         ┃
+┡━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
+│  1   │  ○   │ 完成CLI开发  │   high   │ work       │ 2026-03-20 13:44 │
+└──────┴──────┴──────────────┴──────────┴────────────┴──────────────────┘
+
+# 标记完成
+$ python devkit.py todo done 1
+✓ 任务已完成
+
+# 查看所有任务
+$ python devkit.py todo list --all
+总计: 1 | 待完成: 0 | 已完成: 1
+```
+
+## 数据存储
+
+- **任务数据**：`~/.devkit/todos.json`
+- **日志文件**：`~/.devkit/devkit.log`
+
+## 特性
+
+- ✅ 模块化清晰，单文件实现
+- ✅ 完整的类型提示
+- ✅ 详细的代码注释
+- ✅ 彩色表格输出
+- ✅ 日志记录
+- ✅ 参数校验
+- ✅ 自动生成的帮助文档
+- ✅ 预览模式（dry-run）
+- ✅ 交互式确认
+
+## 许可证
+
+MIT License