@pigcloud/skills 1.0.0

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 (161) hide show
  1. package/CHANGELOG.md +70 -0
  2. package/LICENSE +201 -0
  3. package/README.en.md +84 -0
  4. package/README.md +79 -0
  5. package/bin/cli.js +663 -0
  6. package/bin/postinstall.js +60 -0
  7. package/bin/rules-loader.js +484 -0
  8. package/bin/runtime-bootstrap.js +121 -0
  9. package/index.js +7 -0
  10. package/install.cmd +5 -0
  11. package/install.ps1 +74 -0
  12. package/install.sh +168 -0
  13. package/package.json +70 -0
  14. package/pig-cloud-skills-commands/.codex-plugin/plugin.json +35 -0
  15. package/pig-cloud-skills-commands/README.md +24 -0
  16. package/pig-cloud-skills-commands/commands/analyze.md +21 -0
  17. package/pig-cloud-skills-commands/commands/build.md +21 -0
  18. package/pig-cloud-skills-commands/commands/design.md +21 -0
  19. package/pig-cloud-skills-commands/commands/distill.md +21 -0
  20. package/pig-cloud-skills-commands/commands/doc.md +21 -0
  21. package/pig-cloud-skills-commands/commands/infra.md +21 -0
  22. package/pig-cloud-skills-commands/commands/init.md +20 -0
  23. package/pig-cloud-skills-commands/commands/kb.md +20 -0
  24. package/pig-cloud-skills-commands/commands/perf.md +20 -0
  25. package/pig-cloud-skills-commands/commands/prd.md +21 -0
  26. package/pig-cloud-skills-commands/commands/review.md +21 -0
  27. package/pig-cloud-skills-commands/commands/security.md +21 -0
  28. package/pig-cloud-skills-commands/commands/test.md +21 -0
  29. package/pig-cloud-skills-commands/commands/workflow.md +20 -0
  30. package/rules/bundles.json +358 -0
  31. package/rules/coding/analysis.md +27 -0
  32. package/rules/coding/backend/cache-invalidation.md +30 -0
  33. package/rules/coding/backend/cache-keying.md +30 -0
  34. package/rules/coding/backend/cache.md +37 -0
  35. package/rules/coding/backend/database.md +32 -0
  36. package/rules/coding/backend/feign.md +30 -0
  37. package/rules/coding/backend/index.md +42 -0
  38. package/rules/coding/backend/query.md +32 -0
  39. package/rules/coding/backend/remote.md +33 -0
  40. package/rules/coding/backend/transaction-boundary.md +30 -0
  41. package/rules/coding/backend/transaction-rollback.md +30 -0
  42. package/rules/coding/backend/transaction.md +38 -0
  43. package/rules/coding/boundary.md +25 -0
  44. package/rules/coding/implementation.md +30 -0
  45. package/rules/coding/index.md +38 -0
  46. package/rules/coding/scaffold.md +28 -0
  47. package/rules/coding/testing.md +29 -0
  48. package/rules/coding/validation.md +29 -0
  49. package/rules/core/code-quality.md +30 -0
  50. package/rules/core/evidence.md +26 -0
  51. package/rules/core/index.md +41 -0
  52. package/rules/core/interface.md +26 -0
  53. package/rules/core/iteration.md +26 -0
  54. package/rules/core/layer-boundary.md +25 -0
  55. package/rules/core/logging.md +26 -0
  56. package/rules/core/security.md +26 -0
  57. package/rules/core/task-boundary.md +27 -0
  58. package/rules/docs/api.md +34 -0
  59. package/rules/docs/capture-summary.md +29 -0
  60. package/rules/docs/capture.md +34 -0
  61. package/rules/docs/contract.md +30 -0
  62. package/rules/docs/decision-log.md +32 -0
  63. package/rules/docs/examples.md +28 -0
  64. package/rules/docs/index.md +49 -0
  65. package/rules/docs/reference.md +32 -0
  66. package/rules/index.md +46 -0
  67. package/rules/overlays/index.md +28 -0
  68. package/rules/overlays/pig-cloud/controller.md +33 -0
  69. package/rules/overlays/pig-cloud/dto-vo.md +33 -0
  70. package/rules/overlays/pig-cloud/entity.md +32 -0
  71. package/rules/overlays/pig-cloud/exception.md +32 -0
  72. package/rules/overlays/pig-cloud/layering.md +31 -0
  73. package/rules/overlays/pig-cloud/mapper.md +32 -0
  74. package/rules/overlays/pig-cloud/query-style.md +32 -0
  75. package/rules/overlays/pig-cloud/rest-response.md +33 -0
  76. package/rules/overlays/pig-cloud/service.md +33 -0
  77. package/rules/overlays/pig-cloud/transactions.md +32 -0
  78. package/rules/overlays/pig-cloud/validation.md +33 -0
  79. package/rules/overlays/pig-cloud.md +45 -0
  80. package/rules/product/acceptance.md +25 -0
  81. package/rules/product/briefing.md +27 -0
  82. package/rules/product/index.md +36 -0
  83. package/rules/product/intake.md +27 -0
  84. package/rules/product/modeling.md +25 -0
  85. package/rules/product/project-context.md +29 -0
  86. package/rules/review/code.md +35 -0
  87. package/rules/review/evidence.md +31 -0
  88. package/rules/review/index.md +50 -0
  89. package/rules/review/java.md +42 -0
  90. package/rules/review/performance.md +38 -0
  91. package/rules/review/rubric.md +28 -0
  92. package/rules/review/security.md +38 -0
  93. package/rules/review/ts.md +33 -0
  94. package/rules/review/vue.md +33 -0
  95. package/rules/skill-profile-map.json +58 -0
  96. package/rules/skill-profile-map.md +28 -0
  97. package/rules/workflow/handoff.md +25 -0
  98. package/rules/workflow/index.md +37 -0
  99. package/rules/workflow/refinement.md +29 -0
  100. package/rules/workflow/router.md +25 -0
  101. package/rules/workflow/selection.md +25 -0
  102. package/rules/workflow/stop.md +25 -0
  103. package/scripts/ci-validator.sh +114 -0
  104. package/scripts/run-golden-replays.js +312 -0
  105. package/scripts/validate-rules.js +125 -0
  106. package/scripts/validate-skill-replay-signals.js +75 -0
  107. package/scripts/validate-skill-shapes.js +141 -0
  108. package/scripts/validate-skill-stop-rules.js +139 -0
  109. package/scripts/validate-skills.cmd +3 -0
  110. package/scripts/validate-skills.ps1 +42 -0
  111. package/scripts/validate-skills.sh +36 -0
  112. package/skills/api-docs/SKILL.md +76 -0
  113. package/skills/code-review/SKILL.md +135 -0
  114. package/skills/code-review/references/findings-template.md +51 -0
  115. package/skills/code-review/references/performance-checklist.md +213 -0
  116. package/skills/code-review/references/rubric.md +232 -0
  117. package/skills/code-review/references/rules.md +32 -0
  118. package/skills/code-review/references/security-checklist.md +178 -0
  119. package/skills/code-review/references/stack-notes.md +25 -0
  120. package/skills/code-review/references/template-review.md +214 -0
  121. package/skills/code-review/scripts/lint-code-review.mjs +431 -0
  122. package/skills/domain-modeling/SKILL.md +80 -0
  123. package/skills/domain-modeling/references/README.md +134 -0
  124. package/skills/domain-modeling/references/distillation-checklist.md +152 -0
  125. package/skills/domain-modeling/references/test-cases-template.md +128 -0
  126. package/skills/environment-deploy/SKILL.md +81 -0
  127. package/skills/feature-build/SKILL.md +122 -0
  128. package/skills/feature-build/references/coding-checklist.md +97 -0
  129. package/skills/feature-build/references/comment-specification.md +102 -0
  130. package/skills/knowledge-capture/SKILL.md +84 -0
  131. package/skills/performance-check/SKILL.md +117 -0
  132. package/skills/product-intake/SKILL.md +98 -0
  133. package/skills/project-bootstrap/SKILL.md +80 -0
  134. package/skills/references/agent-personas.md +34 -0
  135. package/skills/references/anti-rationalization.md +144 -0
  136. package/skills/references/engineering-delivery-method.md +63 -0
  137. package/skills/references/engineering-delivery-template.md +80 -0
  138. package/skills/references/flow-test-cases.md +62 -0
  139. package/skills/references/full-chain-replay-scenarios.md +79 -0
  140. package/skills/references/golden-prompt-suite.js +385 -0
  141. package/skills/references/golden-prompt-suite.md +33 -0
  142. package/skills/references/hooks.md +67 -0
  143. package/skills/references/negative-replay-scenarios.md +49 -0
  144. package/skills/references/project-requirement-alignment.md +41 -0
  145. package/skills/references/prompt-replay-checklist.md +128 -0
  146. package/skills/references/requirements-separation-map.md +71 -0
  147. package/skills/references/rule-loading-map.md +108 -0
  148. package/skills/references/skill-authoring-standard.md +73 -0
  149. package/skills/references/skill-boundary-template.md +38 -0
  150. package/skills/references/skill-enhanced-template.md +53 -0
  151. package/skills/references/skill-reference-matrix.md +53 -0
  152. package/skills/references/slash-commands.md +34 -0
  153. package/skills/security-review/SKILL.md +117 -0
  154. package/skills/spec-refinement/SKILL.md +143 -0
  155. package/skills/spec-refinement/references/ears-syntax.md +127 -0
  156. package/skills/spec-refinement/references/requirement-checklist.md +139 -0
  157. package/skills/spec-refinement/references/spec-workbook.md +75 -0
  158. package/skills/technical-design/SKILL.md +105 -0
  159. package/skills/technical-design/references/solid-checklist.md +199 -0
  160. package/skills/test-design/SKILL.md +91 -0
  161. package/skills/workflow-router/SKILL.md +86 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,70 @@
1
+ # Pig Skills CHANGELOG
2
+
3
+ > 版本变更记录,遵循 Semantic Versioning
4
+
5
+ ---
6
+
7
+ ## [1.1.1] - 2026-06-18
8
+
9
+ ### Changed
10
+ - Made postinstall client-aware so it can auto-install into the detected client(s) from `INIT_CWD`.
11
+ - Kept Codex as the only client with a real command pack so `/prd`, `/analyze`, and friends remain executable entries instead of fake aliases.
12
+ - Extended `pig-skills auto` to install the matching client folders for Codex, Claude Code, Trae, Cursor, Copilot, and Windsurf.
13
+ - Clarified in the README and usage docs that only Codex gets `/prd`-style command files, while other clients receive skills and rules.
14
+ - Unified the usage guides around the same client-detection and knowledge-capture model.
15
+
16
+ ## [1.1.0] - 2026-06-18
17
+
18
+ ### Changed
19
+ - 重构 skill 体系说明,按当前 13 个 skill 重新梳理 README 和使用方式
20
+ - 补充统一校验入口 `validate-skills.js`,并增加 Windows / macOS / Linux 壳
21
+ - 将便携 Python 纳入仓库内,避免依赖系统环境
22
+ - 统一 `spec-refinement`、`knowledge-capture`、`workflow-router` 等高频 skill 的识别与门禁表达
23
+ - 收缩 skill frontmatter,按官方 validator 规范保留最小字段
24
+ - 将 `handover` 合并进 `knowledge-capture`,删除独立交接 skill
25
+
26
+ ### Added
27
+ - `validate-skills.js`
28
+ - `validate-skills.cmd`
29
+ - `validate-skills.sh`
30
+ - `.tools/python.cmd`
31
+ - `.tools/python.sh`
32
+
33
+ ## [1.0.0] - 2024-01-20
34
+
35
+ ### Added
36
+ - 初始发布,包含 12 个框架绑定技能
37
+ - OpenSpec 标准化规范
38
+ - 三层渐进式加载机制
39
+ - 跨工具兼容支持(Trae/Cursor/Claude Code/Copilot/Windsurf)
40
+ - CLI 工具(pig-skills 命令)
41
+
42
+ ### Skills
43
+ - **Core**: workflow-router, technical-design, feature-build, code-review
44
+ - **Analysis**: spec-refinement, domain-modeling
45
+ - **Integration**: api-docs, test-design
46
+ - **Collaboration**: knowledge-capture
47
+ - **Infrastructure**: project-bootstrap, environment-deploy
48
+
49
+ ### Core Bindings
50
+ - Controller → Service → Mapper 分层
51
+ - MpRealDelEntity / MpLogicDelEntity 基类
52
+ - Result<T> 统一返回
53
+ - BizException 异常体系
54
+ - Lambda 查询表达式
55
+
56
+ ---
57
+
58
+ ## 计划更新
59
+
60
+ ### [1.2.0] - TBD
61
+ - 技能模板可视化
62
+ - 技能组合编排器
63
+ - 更多框架特定规则
64
+
65
+ ### [2.0.0] - TBD
66
+ - 技能发布平台
67
+ - 技能订阅机制
68
+ - 多框架支持
69
+
70
+
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.en.md ADDED
@@ -0,0 +1,84 @@
1
+ # @pigcloud/skills
2
+
3
+ > An AI skills pack for product, engineering, and QA workflows. `@pigcloud/skills` is the npm package name; `Pig Cloud` is the dedicated rules / scaffold context, while shared skills and specialized rule overlays stay separated.
4
+
5
+ ## What it is
6
+
7
+ - Pick the right skill before acting
8
+ - Skills own task boundaries and handoff
9
+ - `rules/` owns framework constraints and coding conventions
10
+ - Loading and validation are handled by the loader / CLI
11
+
12
+ ## Common entry points
13
+
14
+ - Product intake: `product-intake`
15
+ - Requirement refinement: `spec-refinement`
16
+ - Stage routing: `workflow-router`
17
+ - Design and implementation: `technical-design` / `feature-build`
18
+ - Review: `code-review` / `security-review` / `performance-check`
19
+ - Knowledge capture: `knowledge-capture`
20
+
21
+ ## Install
22
+
23
+ ### Without npm
24
+
25
+ Run the matching script from the repo root:
26
+
27
+ - Windows: `install.cmd`
28
+ - macOS / Linux: `bash install.sh`
29
+
30
+ ### Auto-detect the current project
31
+
32
+ ```bash
33
+ npm install -g @pigcloud/skills
34
+ ```
35
+
36
+ ### Migration note
37
+
38
+ - `@pig/skills` was the intermediate package name during migration.
39
+ - New installs should use `@pigcloud/skills`.
40
+ - `rules/overlays/pig-cloud/` remains the Pig Cloud-specific rule layer and is not the npm package name.
41
+
42
+ ### Codex command entry
43
+
44
+ ```bash
45
+ pig-skills codex
46
+ ```
47
+
48
+ ### Inspect rule loading
49
+
50
+ ```bash
51
+ pig-skills rules
52
+ ```
53
+
54
+ ### Bootstrap runtime
55
+
56
+ ```bash
57
+ pig-skills bootstrap
58
+ ```
59
+
60
+ ## Validation
61
+
62
+ ```bash
63
+ node validate-skills.js
64
+ node scripts/validate-skill-shapes.js
65
+ node scripts/validate-rules.js
66
+ ```
67
+
68
+ ## Directory map
69
+
70
+ - `skills/`: skill bodies
71
+ - `skills/references/`: authoring standard, reference matrix, loading map
72
+ - `rules/`: rule entry point and bundles
73
+ - `docs/`: usage notes, workflow design, and reports
74
+ - `bin/`: CLI, auto-install, postinstall
75
+
76
+ ## Entry docs
77
+
78
+ - [AGENTS.md](AGENTS.md)
79
+ - [docs/README.md](docs/README.md)
80
+ - [docs/package-name-migration.md](docs/package-name-migration.md)
81
+ - [skills/references/skill-authoring-standard.md](skills/references/skill-authoring-standard.md)
82
+ - [skills/references/skill-reference-matrix.md](skills/references/skill-reference-matrix.md)
83
+ - [skills/references/rule-loading-map.md](skills/references/rule-loading-map.md)
84
+ - [README.md](README.md)
package/README.md ADDED
@@ -0,0 +1,79 @@
1
+ # @pigcloud/skills
2
+
3
+ > 面向产品、研发、测试协作的 AI skills pack。`@pigcloud/skills` 是 npm 包名;`Pig Cloud` 是专属规则/脚手架语境,通用 skills 与专属 rules overlay 分层并存。
4
+
5
+ ## 它是什么
6
+
7
+ 这套包的定位很简单:先选对 skill,再开始执行;skill 负责任务边界和交接;`rules/` 负责框架约束和编码规范;规则加载与校验由 `loader` / CLI 负责;面向 AI 的摘要和标签优先用英文,面向人的说明优先用中文。
8
+
9
+ ## 常用入口
10
+
11
+ 1. 产品收口:`product-intake`
12
+ 2. 需求细化:`spec-refinement`
13
+ 3. 阶段路由:`workflow-router`
14
+ 4. 设计与实现:`technical-design` / `feature-build`
15
+ 5. 审核:`code-review` / `security-review` / `performance-check`
16
+ 6. 沉淀:`knowledge-capture`
17
+
18
+ ## 安装
19
+
20
+ ### 没有 npm
21
+
22
+ 在仓库根目录执行对应脚本:
23
+
24
+ 1. Windows: `install.cmd`
25
+ 2. macOS / Linux: `bash install.sh`
26
+
27
+ ### 自动识别当前项目
28
+
29
+ ```bash
30
+ npm install -g @pigcloud/skills
31
+ ```
32
+
33
+ ### 迁移说明
34
+
35
+ 迁移时请记住三件事:`@pig/skills` 是前一版尝试的名称;现在请使用 `@pigcloud/skills`;仓库内的 `rules/overlays/pig-cloud/` 仍保留为 Pig Cloud 专属规则层,不等同于 npm 包名。
36
+
37
+ ### Codex 命令入口
38
+
39
+ ```bash
40
+ pig-skills codex
41
+ ```
42
+
43
+ ### 查看规则加载
44
+
45
+ ```bash
46
+ pig-skills rules
47
+ ```
48
+
49
+ ### 补齐运行时
50
+
51
+ ```bash
52
+ pig-skills bootstrap
53
+ ```
54
+
55
+ ## 验证
56
+
57
+ ```bash
58
+ node validate-skills.js
59
+ node scripts/validate-skill-shapes.js
60
+ node scripts/validate-rules.js
61
+ ```
62
+
63
+ ## 目录
64
+
65
+ 1. `skills/`: skill 本体
66
+ 2. `skills/references/`: 作者规范、参考矩阵、加载图
67
+ 3. `rules/`: 规则入口和 bundle
68
+ 4. `docs/`: 说明、链路设计和报告
69
+ 5. `bin/`: CLI、自动安装、postinstall
70
+
71
+ ## 入口文档
72
+
73
+ - [AGENTS.md](AGENTS.md)
74
+ - [docs/README.md](docs/README.md)
75
+ - [docs/package-name-migration.md](docs/package-name-migration.md)
76
+ - [skills/references/skill-authoring-standard.md](skills/references/skill-authoring-standard.md)
77
+ - [skills/references/skill-reference-matrix.md](skills/references/skill-reference-matrix.md)
78
+ - [skills/references/rule-loading-map.md](skills/references/rule-loading-map.md)
79
+ - [README.en.md](README.en.md)