@guru-ai-product/ai-product-kit 0.1.251112172507 → 0.2.251112181708
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 +54 -10
- package/package.json +1 -1
- package/skills/aipk_design/GURU_AI.md +1 -1
- package/skills/aipk_development/GURU_AI.md +1 -1
- package/skills/aipk_init_project/SKILL.md +8 -38
- package/skills/aipk_init_project/template/AGENTS_TEMPLATE.md +11 -6
- package/skills/aipk_operations/GURU_AI.md +1 -1
- package/skills/aipk_requirements/GURU_AI.md +1 -1
- package/skills/aipk_skill_generate/GURU_AI.md +1 -1
- package/skills/aipk_tool_prompts/GURU_AI.md +1 -1
package/README.md
CHANGED
|
@@ -48,42 +48,86 @@ ROOT/
|
|
|
48
48
|
|
|
49
49
|
## ⚙️ Environment Requirements
|
|
50
50
|
|
|
51
|
-
|
|
52
|
-
|
|
51
|
+
* **Node.js 18+** – required to run `npx ai-product-kit@latest` from `ROOT`.
|
|
52
|
+
* **npm 9+** – provides access to the scoped package and carries your authenticated session, so the sync command can download the latest Skill bundle.
|
|
53
53
|
|
|
54
54
|
## 🛠️ Usage Guide
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
### 📥 Syncing / Updating Skills
|
|
57
|
+
|
|
58
|
+
1. **Sync the latest Skills** from `ROOT` (call the explicit CLI so future additional binaries don't break the command):
|
|
57
59
|
|
|
58
60
|
```bash
|
|
59
61
|
npx ai-product-kit@latest ai-product-kit
|
|
60
62
|
```
|
|
61
63
|
|
|
62
64
|
The command copies the newest Skill bundle (templates, scripts, and `GURU_AI.md` files) into your working tree. Rerun it whenever you pull updates or start a new branch.
|
|
63
|
-
|
|
65
|
+
|
|
66
|
+
2. **Force a fresh download** – if the update doesn't seem to work or you want to make sure you're getting the latest version:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
# Clear npm cache first, then download fresh
|
|
70
|
+
npm cache clean --force
|
|
71
|
+
npx ai-product-kit@latest ai-product-kit
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Use this when the normal update command doesn't update anything, or if you suspect you're not getting the newest version.
|
|
75
|
+
|
|
76
|
+
3. **Check for updates** – to see if a newer version is available:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
# Check the latest version available on npm
|
|
80
|
+
npm view ai-product-kit version
|
|
81
|
+
|
|
82
|
+
# Check when the package was last updated
|
|
83
|
+
npm view ai-product-kit time.modified
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 🤖 Agent Priming
|
|
87
|
+
|
|
88
|
+
4. **Prime your agent** by sending the following sentence after the sync completes:
|
|
64
89
|
|
|
65
90
|
```text
|
|
66
|
-
init project based on
|
|
91
|
+
init project based on ./.claude/skills/aipk_init_project
|
|
67
92
|
```
|
|
68
93
|
|
|
69
94
|
This prompt loads the init-project Skill documented in `AGENTS.md`, ensuring Codex/Cursor follows the canonical workflow every time.
|
|
70
|
-
3. **Review the synced artifacts** – open the relevant `skills/aipk_<lifecycle>/SKILL.md`, verify the bundled checklists and `GURU_AI.md` instructions match your task, and log any new deliverables in the tracker specified by `AGENTS.md` before editing documents.
|
|
71
95
|
|
|
72
|
-
|
|
96
|
+
### 📋 Post-Sync Review
|
|
97
|
+
|
|
98
|
+
5. **Review the synced artifacts** – open the relevant `skills/aipk_<lifecycle>/SKILL.md`, verify the bundled checklists and `GURU_AI.md` instructions match your task, and log any new deliverables in the tracker specified by `AGENTS.md` before editing documents.
|
|
99
|
+
|
|
100
|
+
**Note for agents**: The `list_dir` tool does not display dot-files and dot-directories. To find hidden directories like `.claude/`, use `run_terminal_cmd` with `ls -a` or `ls -la`, or access them directly using absolute paths (e.g., `.claude/skills/`).
|
|
101
|
+
|
|
102
|
+
Once the agent acknowledges the Skill load, continue with your usual prompts (for example, "Prepare the PRD for feature X using the AI Product Kit template.")
|
|
103
|
+
|
|
104
|
+
### 🔧 Having Update Problems?
|
|
105
|
+
|
|
106
|
+
If you're having trouble updating:
|
|
107
|
+
|
|
108
|
+
* **Update not working?** Try clearing the cache first (see force download command above)
|
|
109
|
+
* **Getting errors?** Make sure you have permission to write files in your current folder
|
|
110
|
+
* **Internet problems?** Check your connection and try again
|
|
111
|
+
* **Still stuck?** Try using a different network or wait a few minutes and try again
|
|
73
112
|
|
|
74
113
|
## 🚀 Quick Start
|
|
75
114
|
|
|
76
115
|
Agents already know where each Skill lives because the mappings are declared in `AGENTS.md`. Use prompts like these to get moving quickly:
|
|
77
116
|
|
|
78
|
-
1.
|
|
117
|
+
1.
|
|
118
|
+
|
|
79
119
|
```text
|
|
80
120
|
Draft a PRD for the AI-assisted recording feature using the latest AI Product Kit template.
|
|
81
121
|
```
|
|
82
|
-
|
|
122
|
+
|
|
123
|
+
2.
|
|
124
|
+
|
|
83
125
|
```text
|
|
84
126
|
Review the current launch checklist and tell me what’s missing for the beta cut.
|
|
85
127
|
```
|
|
86
|
-
|
|
128
|
+
|
|
129
|
+
3.
|
|
130
|
+
|
|
87
131
|
```text
|
|
88
132
|
Summarize the deltas between @panel_diff_v2 and the current AI Product Kit design standard, then propose fixes.
|
|
89
133
|
```
|
package/package.json
CHANGED
|
@@ -12,20 +12,14 @@ description: 初始化项目 Agents 文档,同步 skills 清单到 AGENTS.md/
|
|
|
12
12
|
|
|
13
13
|
## 2. 快速上手
|
|
14
14
|
|
|
15
|
-
1.
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
```
|
|
19
|
-
该脚本会将 `skills/` 下所有一级 Skill 的 `name`/`description` 注入 `<skills_system>` 区块,并在每个 Skill 目录生成 `GURU_AI.md`。
|
|
20
|
-
2. 检查项目根目录是否存在 `AGENTS.md` 文件,并确认 `<skills_system>` 区块已经出现
|
|
21
|
-
3. 验证 `AGENTS.md` 是否符合模板结构(使用 [`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md))
|
|
22
|
-
4. 如果缺失或不符合规范,使用模板创建或更新相应文档,随后再次运行脚本确保 Skills 区块与模板保持一致
|
|
15
|
+
1. 检查项目根目录是否存在 `AGENTS.md` 文件,并确认 `<skills_system>` 区块已经出现
|
|
16
|
+
2. 验证 `AGENTS.md` 是否符合模板结构(使用 [`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md))
|
|
17
|
+
3. 如果缺失或不符合规范,使用模板创建或更新相应文档,确保 Skills 区块与模板保持一致
|
|
23
18
|
|
|
24
19
|
## 3. 标准流程
|
|
25
20
|
|
|
26
21
|
| 阶段 | 说明 |
|
|
27
22
|
| ---- | --- |
|
|
28
|
-
| Skills 同步 | 运行 `update_skills.py`,刷新 `<skills_system>` 区块并生成各 Skill 的 `GURU_AI.md` |
|
|
29
23
|
| 检查 | 检查项目根目录是否存在 `AGENTS.md`,如缺失则创建 |
|
|
30
24
|
| 校验 | 对照模板逐节检查文档结构是否完整,必要时重建 |
|
|
31
25
|
|
|
@@ -69,20 +63,7 @@ description: 初始化项目 Agents 文档,同步 skills 清单到 AGENTS.md/
|
|
|
69
63
|
|
|
70
64
|
## 5. AI 协作要点
|
|
71
65
|
|
|
72
|
-
### 5.1
|
|
73
|
-
|
|
74
|
-
- **脚本位置**:`tools/update_skills.py`
|
|
75
|
-
- **作用**:
|
|
76
|
-
- 读取 `skills/` 一级目录的 `SKILL.md` front matter,生成 `<skills_system>` 区块
|
|
77
|
-
- 更新 `AGENTS.md` 与 [`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md) 的 `<skills_system>` 内容
|
|
78
|
-
- 在每个 Skill 目录生成/更新 `GURU_AI.md`,列出该目录下所有文件的最新修改时间(UTC)
|
|
79
|
-
- **用法示例**:
|
|
80
|
-
```bash
|
|
81
|
-
python tools/update_skills.py --targets AGENTS.md skills/aipk_init_project/template/AGENTS_TEMPLATE.md
|
|
82
|
-
```
|
|
83
|
-
- **可选项**:如果只想更新文档而跳过 `GURU_AI.md`,可追加 `--skip-guru`
|
|
84
|
-
|
|
85
|
-
### 5.2 检查脚本
|
|
66
|
+
### 5.1 检查脚本
|
|
86
67
|
|
|
87
68
|
使用以下逻辑检查项目:
|
|
88
69
|
|
|
@@ -110,7 +91,6 @@ grep -q "Special Rules" AGENTS.md || echo "缺少 Special Rules"
|
|
|
110
91
|
- 检查文档结构是否符合模板要求
|
|
111
92
|
- 如果不符合,使用模板重新创建或更新
|
|
112
93
|
- 确保除了 **Project Overview** 外,其他内容与模板一致
|
|
113
|
-
- 修改完成后再次运行 `update_skills.py`,同步 `<skills_system>` 和 `GURU_AI.md`
|
|
114
94
|
|
|
115
95
|
### 5.4 模板使用规范
|
|
116
96
|
|
|
@@ -121,16 +101,7 @@ grep -q "Special Rules" AGENTS.md || echo "缺少 Special Rules"
|
|
|
121
101
|
|
|
122
102
|
## 6. 执行步骤
|
|
123
103
|
|
|
124
|
-
### 步骤 1:
|
|
125
|
-
|
|
126
|
-
```bash
|
|
127
|
-
python tools/update_skills.py --targets AGENTS.md skills/aipk_init_project/template/AGENTS_TEMPLATE.md
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
- 确保命令执行无误,`AGENTS.md` 与模板都生成 `<skills_system>` 区块
|
|
131
|
-
- 检查 `skills/*/GURU_AI.md` 是否已刷新,必要时在提交前 review 变动内容
|
|
132
|
-
|
|
133
|
-
### 步骤 2: 检查现有文档
|
|
104
|
+
### 步骤 1: 检查现有文档
|
|
134
105
|
|
|
135
106
|
```bash
|
|
136
107
|
# 检查根目录 AGENTS.md
|
|
@@ -141,7 +112,7 @@ else
|
|
|
141
112
|
fi
|
|
142
113
|
```
|
|
143
114
|
|
|
144
|
-
### 步骤
|
|
115
|
+
### 步骤 2: 验证文档内容
|
|
145
116
|
|
|
146
117
|
检查 `AGENTS.md` 是否包含以下关键章节:
|
|
147
118
|
|
|
@@ -155,16 +126,15 @@ fi
|
|
|
155
126
|
- Language Preference
|
|
156
127
|
- MCP AI Product Kit Integration (Mandatory)
|
|
157
128
|
|
|
158
|
-
### 步骤
|
|
129
|
+
### 步骤 3: 创建或更新文档
|
|
159
130
|
|
|
160
131
|
如果缺失或不符合规范:
|
|
161
132
|
|
|
162
133
|
1. 使用 [`template/AGENTS_TEMPLATE.md`](./template/AGENTS_TEMPLATE.md) 作为模板
|
|
163
134
|
2. **仅修改 Project Overview 部分**,填写项目的实际信息
|
|
164
135
|
3. **其他所有内容严格按照模板**,不得修改
|
|
165
|
-
4. 更新完成后再次运行步骤 1 的脚本,刷新 `<skills_system>` 和 `GURU_AI.md`
|
|
166
136
|
|
|
167
|
-
### 步骤
|
|
137
|
+
### 步骤 4: 验证完整性
|
|
168
138
|
|
|
169
139
|
最终 `AGENTS.md` 应包含:
|
|
170
140
|
|
|
@@ -47,6 +47,11 @@
|
|
|
47
47
|
* **Document date updates**: Check and update document creation or modification date fields
|
|
48
48
|
* **Date format**: Use `YYYYMMDD` format
|
|
49
49
|
|
|
50
|
+
### 4. Tool Usage Guidelines
|
|
51
|
+
|
|
52
|
+
* **Hidden directories**: The `list_dir` tool does not display dot-files and dot-directories. To find hidden directories like `.claude/`, use `run_terminal_cmd` with `ls -a` or `ls -la`, or access them directly using absolute paths (e.g., `.claude/skills/`).
|
|
53
|
+
* When searching for Skills in user projects, check `.claude/skills/` directory using terminal commands if `list_dir` doesn't show it.
|
|
54
|
+
|
|
50
55
|
## Agents Prohibited Behaviors
|
|
51
56
|
|
|
52
57
|
The following behaviors are **prohibited**:
|
|
@@ -99,37 +104,37 @@ Usage notes:
|
|
|
99
104
|
<skill>
|
|
100
105
|
<name>design</name>
|
|
101
106
|
<description>Central hub for automation-ready design workflows, describing how agents split composite boards, prep visual assets, sync requirement docs, and discover the right sub-skill before handling new mocks.</description>
|
|
102
|
-
<location
|
|
107
|
+
<location>.claude/skills/aipk_design</location>
|
|
103
108
|
</skill>
|
|
104
109
|
|
|
105
110
|
<skill>
|
|
106
111
|
<name>development</name>
|
|
107
112
|
<description>Development phase index pointing to the single authoritative implementation plan template.</description>
|
|
108
|
-
<location
|
|
113
|
+
<location>.claude/skills/aipk_development</location>
|
|
109
114
|
</skill>
|
|
110
115
|
|
|
111
116
|
<skill>
|
|
112
117
|
<name>operations</name>
|
|
113
118
|
<description>Canonical entry point for every post-release operating guide; maps scenarios to the available Skills and explains how to invoke them.</description>
|
|
114
|
-
<location
|
|
119
|
+
<location>.claude/skills/aipk_operations</location>
|
|
115
120
|
</skill>
|
|
116
121
|
|
|
117
122
|
<skill>
|
|
118
123
|
<name>requirements</name>
|
|
119
124
|
<description>Central repository for requirement discovery, documentation, review, and change management assets.</description>
|
|
120
|
-
<location
|
|
125
|
+
<location>.claude/skills/aipk_requirements</location>
|
|
121
126
|
</skill>
|
|
122
127
|
|
|
123
128
|
<skill>
|
|
124
129
|
<name>skill-creation</name>
|
|
125
130
|
<description>Standards and methods for creating Agent Skills that extend Claude's capabilities. Use when creating or updating Skills, rules, or documentation that should follow Skill structure.</description>
|
|
126
|
-
<location
|
|
131
|
+
<location>.claude/skills/aipk_skill_generate</location>
|
|
127
132
|
</skill>
|
|
128
133
|
|
|
129
134
|
<skill>
|
|
130
135
|
<name>tool_prompts</name>
|
|
131
136
|
<description>Catalog of reusable prompts for AI tooling workflows, including their usage guidance and file locations.</description>
|
|
132
|
-
<location
|
|
137
|
+
<location>.claude/skills/aipk_tool_prompts</location>
|
|
133
138
|
</skill>
|
|
134
139
|
|
|
135
140
|
</available_skills>
|