pm-workflow-studio 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +79 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,28 +1,98 @@
1
1
  # PM Workflow Studio
2
2
 
3
- AI 产品开发工作室 CLI。安装后用一条命令生成 Codex 或 Claude Code 可直接使用的产品工作室目录。
3
+ AI 产品开发工作室 CLI。把一句产品想法,初始化成 Codex 或 Claude Code 可直接使用的产品工作室目录。
4
4
 
5
- ## Install
5
+ ## 安装
6
6
 
7
7
  ```bash
8
- npm install -g .
8
+ npm install -g pm-workflow-studio
9
9
  ```
10
10
 
11
- 如果你在仓库根目录调试,进入本包目录再安装:
11
+ 安装后会得到两个等价命令:
12
12
 
13
13
  ```bash
14
- cd skills/pm/pm-workflow
15
- npm install -g .
14
+ pmflow --help
15
+ pm-workflow --help
16
16
  ```
17
17
 
18
- ## Usage
18
+ ## 快速开始
19
+
20
+ Codex:
19
21
 
20
22
  ```bash
21
23
  pmflow init --ai codex --root ./pm-workflow-demo --name "习惯打卡"
24
+ cd ./pm-workflow-demo
25
+ codex
26
+ ```
27
+
28
+ 进入 Codex 后,直接说:
29
+
30
+ ```text
31
+ 我想做一个习惯打卡小程序
32
+ ```
33
+
34
+ Claude Code:
35
+
36
+ ```bash
22
37
  pmflow init --ai claude --root ./pm-workflow-claude-demo --name "习惯打卡"
38
+ cd ./pm-workflow-claude-demo
39
+ claude
40
+ ```
41
+
42
+ 进入 Claude Code 后,直接说产品想法,或运行:
43
+
44
+ ```text
45
+ /pm-workflow:init
46
+ ```
47
+
48
+ ## 命令参数
49
+
50
+ ```bash
23
51
  pmflow init --ai auto --name "习惯打卡"
52
+ pmflow init --ai codex --root ./pm-workflow-demo --name "习惯打卡"
53
+ pmflow init --ai claude --root ./pm-workflow-claude-demo --name "习惯打卡"
54
+ ```
55
+
56
+ - `--ai auto|codex|claude`:选择生成结构。默认 `auto`;空目录默认 Codex;目录已有 `.claude/` 时选择 Claude Code。
57
+ - `--root <dir>`:目标项目目录,默认当前目录。
58
+ - `--name <product name>`:产品名称,默认 `My Product`。
59
+ - `--cli` 是 `--ai` 的别名。
60
+
61
+ 当前支持 Codex 和 Claude Code;`kiro` 暂未支持。
62
+
63
+ ## 生成内容
64
+
65
+ Codex 结构会生成:
66
+
67
+ ```text
68
+ .codex/
69
+ .agents/skills/pm-workflow/
70
+ .agents/skills/impeccable/
71
+ docs/
72
+ prototype/
73
+ outputs/dev-package/
24
74
  ```
25
75
 
26
- `pmflow` 也提供 `pm-workflow` 命令别名。
76
+ Claude Code 结构会生成:
27
77
 
28
- `pmflow init` 只依赖 Node.js,不依赖 Python。包内只维护 `.codex/` 和 `.claude/` 两套结构镜像;初始化时按 `--ai` 选择复制对应结构。
78
+ ```text
79
+ .claude/agents/
80
+ .claude/commands/
81
+ .claude/skills/pm-workflow/
82
+ .claude/skills/impeccable/
83
+ docs/
84
+ prototype/
85
+ outputs/dev-package/
86
+ ```
87
+
88
+ `pmflow init` 只依赖 Node.js,不依赖 Python。包内维护 `.codex/` 和 `.claude/` 两套结构镜像,审核与打包脚本也使用 Node。
89
+
90
+ ## 本地开发
91
+
92
+ 在本仓库调试包:
93
+
94
+ ```bash
95
+ cd skills/pm/pm-workflow
96
+ npm test
97
+ node bin/pmflow.js init --ai codex --root /tmp/pmflow-demo --name "习惯打卡"
98
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pm-workflow-studio",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "AI product development studio CLI for Codex and Claude Code.",
5
5
  "type": "commonjs",
6
6
  "bin": {