shawnxixi-cli 0.3.0 → 1.1.0

package/.env.example

@@ -1,2 +1,8 @@
-SHAWNXIXI_API_URL=http://server.shawnxixi.icu
-SHAWNXIXI_API_TOKEN=
+# 肖嘻 CLI 配置文件
+# 复制此文件为 .env 并填入实际值
+
+# API 地址（默认：http://localhost:8080/api/v1）
+SHAWNXIXI_API_URL=http://localhost:8080/api/v1
+
+# API Token（可选，用于认证）
+# SHAWNXIXI_API_TOKEN=your_token_here

package/.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: CI/CD
+name: CI
 
 on:
   push:
@@ -14,6 +14,8 @@ jobs:
         node-version: [20.x]
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4
         with:
@@ -21,28 +23,13 @@ jobs:
           cache: npm
       - name: Install dependencies
         run: npm ci
+      - name: Run commitlint
+        run: npx commitlint --from ${{ github.event.pull_request.base.sha || github.event.commits[0].sha }} --to HEAD --verbose
+        if: github.event_name == 'pull_request'
+      - name: Run commitlint on last commit
+        run: npx commitlint --last --verbose
+        if: github.event_name == 'push'
       - name: Build
         run: npm run build
       - name: Test
         run: npm test
-
-  publish:
-    needs: build-test
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install dependencies
-        run: npm ci
-      - name: Build
-        run: npm run build
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-

package/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # needed for semantic-release to push tags
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Release
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CLAUDE.md

@@ -2,69 +2,154 @@
 
 ## 项目说明
 
-肖嘻 CLI 工具，OpenClaw 的执行肢。通过 HTTP 调用 shawnxixi-server REST API。
+肖嘻 CLI 工具，通过 HTTP 调用 shawnxixi-server REST API。
 
 ## 技术栈
 
-- **Runtime**: Node.js 20+
-- **语言**: TypeScript 5.3
-- **HTTP Client**: axios
-- **测试**: Jest + ts-jest
-- **构建**: tsc
-
-## CLI 命令格式
-
-```
-shawnxixi <命名空间> <操作> [参数]
-```
-
-### biz 命名空间（日常业务）
-
-| 操作 | 命令格式 | 说明 |
-|------|---------|------|
-| todo create | `shawnxixi biz todo create "{title}" --due {date} --priority {priority}` | 创建待办 |
-| todo list | `shawnxixi biz todo list --status {status}` | 列出待办 |
-| todo update | `shawnxixi biz todo update {id} --status {status}` | 更新待办 |
-| todo delete | `shawnxixi biz todo delete {id}` | 删除待办 |
-| record create | `shawnxixi biz record create "{title}" --type {type} --content "{content}" --tags {tags}` | 创建记录 |
-| record list | `shawnxixi biz record list --type {type}` | 列出记录 |
-| finance create | `shawnxixi biz finance create --amount {amount} --type {type} --category {category}` | 记账 |
-| finance list | `shawnxixi biz finance list --type {type}` | 列出账单 |
-| item create | `shawnxixi biz item create "{name}" --category {category}` | 添加物品 |
-| item list | `shawnxixi biz item list --category {category}` | 列出物品 |
-| calendar create | `shawnxixi biz calendar create "{title}" --start {startTime} --end {endTime}` | 创建日程 |
-| calendar list | `shawnxixi biz calendar list --start {startTime} --end {endTime}` | 列出日程 |
-| reminder create | `shawnxixi biz reminder create "{title}" --trigger "{triggerTime}" --type {type}` | 创建提醒 |
-| reminder list | `shawnxixi biz reminder list --status {status}` | 列出提醒 |
-| audit list | `shawnxixi biz audit list --entityType {entityType} --operation {operation}` | 查看审计日志 |
-| task create | `shawnxixi biz task create "{title}" --priority {priority}` | 创建任务 |
-| task list | `shawnxixi biz task list --status {status}` | 列出任务 |
-
-### sys 命名空间（系统操作）
-
-| 操作 | 命令格式 | 说明 |
-|------|---------|------|
-| health query | `shawnxixi sys health query --dataType {dataType} --startDate {startDate} --endDate {endDate}` | 查询健康数据 |
-| health sync | `shawnxixi sys health sync` | 同步健康数据 |
-
-## API 端点（Server v1）
-
-所有 API 基础路径：`http://localhost:8080/api/v1`
-
-| 端点 | 方法 | 说明 |
-|------|------|------|
-| `/api/v1/todos` | GET/POST | 待办列表/创建 |
-| `/api/v1/todos/{id}` | GET/PUT/PATCH/DELETE | 待办详情/更新/删除 |
-| `/api/v1/records` | GET/POST | 记录列表/创建 |
-| `/api/v1/records/{id}` | GET/PUT/PATCH/DELETE | 记录详情/更新/删除 |
-| `/api/v1/finances` | GET/POST | 账单列表/创建 |
-| `/api/v1/items` | GET/POST | 物品列表/创建 |
-| `/api/v1/calendar-events` | GET/POST | 日程列表/创建 |
-| `/api/v1/reminders` | GET/POST | 提醒列表/创建 |
-| `/api/v1/audit-logs` | GET | 审计日志（只读） |
-| `/api/v1/tasks` | GET/POST | 任务列表/创建 |
-| `/api/v1/health-data` | GET/POST | 健康数据 |
-| `/api/v1/health-data/sync` | POST | 同步健康数据 |
+- Node.js 18+ + TypeScript
+- Commander.js 14 + Axios
+
+## CLI 规范
+
+- 命令结构：`biz <module> <action> [args]` 或 `sys <command>`
+- 全局参数：`--url`, `--json`, `--quiet`, `--dry-run`
+- Error 输出格式：红色 `[ERROR] 模块: 描述`
+
+## 全局参数
+
+| 参数 | 说明 |
+|------|------|
+| `--url` | API 基础地址，默认 `http://localhost:8080` |
+| `--json` | 输出 JSON 格式 |
+| `--quiet` | 静默模式（只输出关键信息）|
+| `--dry-run` | 预览模式（不实际调用 API，打印请求参数）|
+
+## 命令格式
+
+### biz todo（待办管理，对标滴答清单）
+
+```
+biz todo create "<title>" [options]     创建待办
+biz todo list [options]                 列出待办
+biz todo edit <id> [options]            编辑待办
+biz todo done <id>                      标记待办完成
+biz todo delete <id>                    删除待办
+biz todo repeat <id>                   完成并生成下次 occurrence（重复待办）
+biz todo subtask <parent-id> --title <title>   创建子待办
+biz todo subtasks <parent-id>           列出子待办
+
+Options:
+  --due <date>          截止日期 YYYY-MM-DD
+  --priority <level>    优先级 low|medium|high (default: medium)
+  --tags <tags>         标签，逗号分隔
+  --status <status>     状态 pending|done（list/edit）
+  --repeat <rule>       重复规则 daily|weekly|monthly
+  --end-date <date>     重复结束日期 YYYY-MM-DD
+  --parent-id <id>      父待办 ID（创建子待办时）
+```
+
+### biz task（任务管理，对标系统任务）
+
+```
+biz task create <title> [options]   创建任务
+biz task list [options]             列出任务
+biz task update <id> [options]      更新任务
+biz task delete <id>                删除任务
+
+Options:
+  --source <source>    来源 openclaw|cli (default: cli)
+  --openclaw-id <id>  OpenClaw ID
+  --priority <level>  优先级 low|medium|high (default: medium)
+  --status <status>   状态 pending|running|done
+```
+
+### biz record（记录管理：日记/宠物/笔记/想法）
+
+```
+biz record create <title> [options]   创建记录
+biz record list [options]             列出记录
+
+Options:
+  --content <text>   内容
+  --type <type>      类型 diary|pet|note|idea (default: diary)
+  --tags <tags>      标签，逗号分隔
+```
+
+### biz finance（财务管理，对标记账类 App）
+
+```
+biz finance create <amount> [options]   记一笔账
+biz finance list [options]               列出账单
+biz finance stats [options]             账单统计
+biz finance report [options]             月度报表
+
+Options:
+  --type <type>      类型 income|expense (default: expense)
+  --category <cat>   分类
+  --note <text>      备注
+  --account <act>    账户 cash|card|alipay|wechat (default: cash)
+  --date <date>      日期 YYYY-MM-DD
+  --tags <tags>      标签，逗号分隔
+  --month <month>    月份 YYYY-MM (stats/report)
+```
+
+### biz item（物品管理，对标物品清单 App）
+
+```
+biz item create <name> [options]   添加物品
+biz item list [options]            列出物品
+biz item expiring [options]        即将过期的物品
+biz item stats                     物品库存统计
+
+Options:
+  --location <loc>       存放位置
+  --expire <date>        过期日期 YYYY-MM-DD
+  --category <cat>       分类
+  --quantity <n>         数量
+  --unit <unit>          单位 个|瓶|盒|kg|g|ml|l
+  --brand <brand>        品牌
+  --barcode <code>       条码
+  --price <price>        价格
+  --supplier <supplier> 供应商
+  --purchase-date <date> 购买日期 YYYY-MM-DD
+  --days <n>             提前多少天提醒 (default: 7, expiring 命令)
+```
+
+### biz calendar（日程管理，对标日历 App）
+
+```
+biz calendar create <title> --from <datetime> --to <datetime> [options]   创建日程
+biz calendar list [options]                                           列出日程
+
+Options:
+  --from <datetime>  开始时间 YYYY-MM-DD 或 YYYY-MM-DD HH:MM（必需）
+  --to <datetime>    结束时间 YYYY-MM-DD 或 YYYY-MM-DD HH:MM（必需）
+  --location <loc>   地点
+  --color <color>    颜色 HEX 如 #ff0000
+  --desc <text>      描述
+```
+
+### biz health（健康数据管理，对标 Apple Health）
+
+```
+biz health log --type <type> --value <value> [options]   记录健康数据
+biz health list [options]                                查询健康数据
+biz health sync                                          同步健康数据（保留兼容）
+
+Options:
+  --type <type>    数据类型 heart_rate|steps|weight|sleep|blood_pressure|oxygen|body_temp（必需，log 命令）
+  --value <value>  数值（必需，log 命令）
+  --unit <unit>    单位 bpm|kg|steps|hours|mmHg|%|°C
+  --date <date>    日期 YYYY-MM-DD (default: 今天)
+  --from <date>    开始日期 YYYY-MM-DD（list 命令）
+  --to <date>      结束日期 YYYY-MM-DD（list 命令）
+```
+
+### sys（系统命令）
+
+```
+sys health   健康检查（返回 { status: 'ok', timestamp })
+```
 
 ## 环境变量
 
@@ -78,8 +163,7 @@ shawnxixi <命名空间> <操作> [参数]
 ## npm 发包
 
 - 包名：`shawnxixi-cli`（npmjs.com）
-- 发布命令：`npm publish --access public`
-- CI 自动发包：main 分支合并时通过 GitHub Actions 触发，需配置 `NPM_TOKEN` secret
+- CI 自动发版：main 分支合并触发 semantic-release 自动发版
 
 ## 启动开发
 
@@ -93,10 +177,30 @@ npm test
 
 ```
 src/
-├── index.ts           # CLI 入口
+├── index.ts           # CLI 入口（所有命令定义）
 ├── commands/          # 命令实现
 │   ├── biz/          # 业务命令
+│   │   ├── todo.ts     # 待办：create/list/edit/done/delete/repeat/subtask/subtasks
+│   │   ├── task.ts     # 任务：create/list/update/delete
+│   │   ├── record.ts   # 记录：create/list
+│   │   ├── finance.ts  # 财务：create/list/stats/report
+│   │   ├── item.ts     # 物品：create/list/expiring/stats
+│   │   ├── calendar.ts # 日程：create/list
+│   │   └── health.ts   # 健康：log/list/sync
 │   └── sys/          # 系统命令
+│       └── health.ts # 健康检查
 └── services/
     └── api.ts        # HTTP API 调用层
 ```
+
+## 发版说明
+
+发版由 semantic-release 全自动管理，触发条件：
+- `feat:` → minor 版本 +1
+- `fix:` → patch 版本 +1
+- `BREAKING CHANGE` in commit → major 版本 +1
+- `chore:` / `docs:` 等 → 不发版
+
+## API 依赖
+
+CLI 完全依赖 `shawnxixi-server` REST API，本地开发需确保 server 运行在 `http://localhost:8080`（或通过 `--url` 指定）。