prd-workflow-cli 1.4.0 → 1.4.1
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 +42 -17
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -55,37 +55,44 @@ C3(版本冻结)
|
|
|
55
55
|
|
|
56
56
|
## 🚀 安装
|
|
57
57
|
|
|
58
|
-
### 方式1
|
|
58
|
+
### 方式1：npx 直接运行（无需安装）✨
|
|
59
59
|
|
|
60
|
-
|
|
60
|
+
无需全局安装，直接使用 npx 运行任何命令：
|
|
61
61
|
|
|
62
62
|
```bash
|
|
63
|
-
#
|
|
63
|
+
# 初始化新项目（推荐）
|
|
64
|
+
npx -y prd-workflow-cli@latest init 我的项目
|
|
65
|
+
|
|
66
|
+
# 或者进入空目录直接初始化
|
|
64
67
|
mkdir 我的项目 && cd 我的项目
|
|
68
|
+
npx -y prd-workflow-cli@latest
|
|
65
69
|
|
|
66
|
-
#
|
|
67
|
-
npx prd-workflow-cli
|
|
68
|
-
```
|
|
70
|
+
# 查看帮助
|
|
71
|
+
npx prd-workflow-cli@latest --help
|
|
69
72
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
- ✅ `.cursorrules` - Cursor AI 规则
|
|
73
|
-
- ✅ `.antigravity/` - Antigravity AI 规则
|
|
73
|
+
# 规则校验 (v1.4.0 新增)
|
|
74
|
+
npx prd-workflow-cli@latest check
|
|
74
75
|
|
|
75
|
-
|
|
76
|
-
|
|
76
|
+
# 统计报告 (v1.4.0 新增)
|
|
77
|
+
npx prd-workflow-cli@latest stats
|
|
78
|
+
```
|
|
77
79
|
|
|
78
|
-
|
|
80
|
+
> 💡 **建议使用 `@latest` 确保使用最新版本**
|
|
81
|
+
>
|
|
82
|
+
> ⚠️ 不加 `@latest` 可能使用缓存的旧版本
|
|
79
83
|
|
|
80
|
-
|
|
84
|
+
### 方式2：全局安装（推荐频繁使用者）
|
|
81
85
|
|
|
82
86
|
```bash
|
|
83
87
|
npm install -g prd-workflow-cli
|
|
84
88
|
|
|
85
|
-
#
|
|
89
|
+
# 验证安装
|
|
90
|
+
prd --version # 应该显示 1.4.0
|
|
91
|
+
|
|
92
|
+
# 然后直接使用 prd 命令
|
|
86
93
|
prd init 我的项目
|
|
87
|
-
|
|
88
|
-
|
|
94
|
+
prd check
|
|
95
|
+
prd stats
|
|
89
96
|
```
|
|
90
97
|
|
|
91
98
|
### 方式3：从源码安装
|
|
@@ -229,6 +236,24 @@ prd iteration list # 查看所有迭代
|
|
|
229
236
|
| `prd review r1` | 执行 R1 规划审视 |
|
|
230
237
|
| `prd review r2` | 执行 R2 版本审视 |
|
|
231
238
|
|
|
239
|
+
### 规则校验 (v1.4.0 新增)
|
|
240
|
+
|
|
241
|
+
| 命令 | 说明 |
|
|
242
|
+
|------|------|
|
|
243
|
+
| `prd check` | 检查项目是否符合 PRD 规则 |
|
|
244
|
+
| `prd check --json` | 输出 JSON 格式（供 AI 读取） |
|
|
245
|
+
| `prd check --no-log` | 不记录日志 |
|
|
246
|
+
| `prd stats` | 显示规则统计报告 |
|
|
247
|
+
| `prd stats --json` | 输出 JSON 格式统计 |
|
|
248
|
+
|
|
249
|
+
### 其他命令
|
|
250
|
+
|
|
251
|
+
| 命令 | 说明 |
|
|
252
|
+
|------|------|
|
|
253
|
+
| `prd ui [file]` | 启动 A2UI 界面预览服务 |
|
|
254
|
+
| `prd upgrade` | 更新项目中的 workflows 和 AI 规则 |
|
|
255
|
+
| `prd index` | 生成/更新迭代索引 |
|
|
256
|
+
|
|
232
257
|
## 🤖 与 AI IDE 集成
|
|
233
258
|
|
|
234
259
|
本工具专门设计用于与 AI 编程助手配合使用。
|