@mytechtoday/augment-extensions 0.2.0 → 0.4.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 (244) hide show
  1. package/README.md +614 -39
  2. package/augment-extensions/coding-standards/bash/README.md +196 -0
  3. package/augment-extensions/coding-standards/bash/module.json +163 -0
  4. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -0
  5. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -0
  6. package/augment-extensions/coding-standards/css/README.md +40 -0
  7. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -0
  8. package/augment-extensions/coding-standards/css/module.json +44 -0
  9. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -0
  10. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -0
  11. package/augment-extensions/coding-standards/html/README.md +40 -0
  12. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -0
  13. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -0
  14. package/augment-extensions/coding-standards/html/module.json +44 -0
  15. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -0
  16. package/augment-extensions/coding-standards/html-css-js/README.md +194 -0
  17. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -0
  18. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -0
  19. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -0
  20. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -0
  21. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -0
  22. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -0
  23. package/augment-extensions/coding-standards/html-css-js/module.json +48 -0
  24. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -0
  25. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -0
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -0
  27. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -0
  28. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -0
  29. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -0
  30. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -0
  31. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -0
  32. package/augment-extensions/coding-standards/js/README.md +46 -0
  33. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -0
  34. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -0
  35. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -0
  36. package/augment-extensions/coding-standards/js/module.json +49 -0
  37. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -0
  38. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -0
  39. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -0
  40. package/augment-extensions/coding-standards/js/rules/performance.md +463 -0
  41. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -0
  42. package/augment-extensions/coding-standards/php/README.md +248 -0
  43. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -0
  44. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -0
  45. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -0
  46. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -0
  47. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -0
  48. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -0
  49. package/augment-extensions/coding-standards/php/module.json +166 -0
  50. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -0
  51. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -0
  52. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -0
  53. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -0
  54. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -0
  55. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -0
  56. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -0
  57. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -0
  58. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -0
  59. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -0
  60. package/augment-extensions/coding-standards/php/rules/performance.md +392 -0
  61. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -0
  62. package/augment-extensions/coding-standards/php/rules/security.md +358 -0
  63. package/augment-extensions/coding-standards/php/rules/testing.md +403 -0
  64. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -0
  65. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -0
  66. package/augment-extensions/coding-standards/powershell/README.md +154 -0
  67. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -0
  68. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -0
  69. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -0
  70. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -0
  71. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -0
  72. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -0
  73. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -0
  74. package/augment-extensions/coding-standards/powershell/module.json +165 -0
  75. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -0
  76. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -0
  77. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -0
  78. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -0
  79. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -0
  80. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -0
  81. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -0
  82. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -0
  83. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -0
  84. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -0
  85. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -0
  86. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -0
  87. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -0
  88. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -0
  89. package/augment-extensions/coding-standards/python/README.md +12 -8
  90. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -0
  91. package/augment-extensions/coding-standards/python/module.json +8 -4
  92. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -0
  93. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -0
  94. package/augment-extensions/coding-standards/python/rules/error-handling.md +855 -68
  95. package/augment-extensions/coding-standards/python/rules/testing.md +409 -0
  96. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -0
  97. package/augment-extensions/coding-standards/python/rules/type-hints.md +115 -50
  98. package/augment-extensions/collections/html-css-js/README.md +82 -0
  99. package/augment-extensions/collections/html-css-js/collection.json +41 -0
  100. package/augment-extensions/domain-rules/database/README.md +161 -0
  101. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -0
  102. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -0
  103. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -0
  104. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -0
  105. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -0
  106. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -0
  107. package/augment-extensions/domain-rules/database/module.json +28 -0
  108. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -0
  109. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -0
  110. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -0
  111. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -0
  112. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -0
  113. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -0
  114. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -0
  115. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -0
  116. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -0
  117. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -0
  118. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -0
  119. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -0
  120. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -0
  121. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -0
  122. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -0
  123. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -0
  124. package/augment-extensions/domain-rules/mcp/README.md +150 -0
  125. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -0
  126. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -0
  127. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -0
  128. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -0
  129. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -0
  130. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -0
  131. package/augment-extensions/domain-rules/mcp/module.json +49 -0
  132. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -0
  133. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -0
  134. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -0
  135. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -0
  136. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -0
  137. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -0
  138. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -0
  139. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -0
  140. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -0
  141. package/augment-extensions/workflows/beads/module.json +4 -3
  142. package/augment-extensions/workflows/database/README.md +195 -0
  143. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -0
  144. package/augment-extensions/workflows/database/examples/migration-example.md +498 -0
  145. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -0
  146. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -0
  147. package/augment-extensions/workflows/database/module.json +42 -0
  148. package/augment-extensions/workflows/database/rules/data-migration.md +249 -0
  149. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -0
  150. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -0
  151. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -0
  152. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -0
  153. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -0
  154. package/augment-extensions/workflows/database/rules/workflow.md +458 -0
  155. package/augment-extensions/workflows/openspec/module.json +4 -3
  156. package/augment-extensions/writing-standards/screenplay/README.md +171 -0
  157. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -0
  158. package/augment-extensions/writing-standards/screenplay/module.json +124 -0
  159. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -0
  160. package/cli/MODULES.md +302 -0
  161. package/cli/dist/cli.js +142 -9
  162. package/cli/dist/cli.js.map +1 -1
  163. package/cli/dist/commands/catalog.d.ts +13 -0
  164. package/cli/dist/commands/catalog.d.ts.map +1 -0
  165. package/cli/dist/commands/catalog.js +104 -0
  166. package/cli/dist/commands/catalog.js.map +1 -0
  167. package/cli/dist/commands/gui.d.ts +6 -0
  168. package/cli/dist/commands/gui.d.ts.map +1 -0
  169. package/cli/dist/commands/gui.js +211 -0
  170. package/cli/dist/commands/gui.js.map +1 -0
  171. package/cli/dist/commands/init.d.ts.map +1 -1
  172. package/cli/dist/commands/init.js +12 -0
  173. package/cli/dist/commands/init.js.map +1 -1
  174. package/cli/dist/commands/install-rules.d.ts +14 -0
  175. package/cli/dist/commands/install-rules.d.ts.map +1 -0
  176. package/cli/dist/commands/install-rules.js +127 -0
  177. package/cli/dist/commands/install-rules.js.map +1 -0
  178. package/cli/dist/commands/link.d.ts.map +1 -1
  179. package/cli/dist/commands/link.js +9 -11
  180. package/cli/dist/commands/link.js.map +1 -1
  181. package/cli/dist/commands/list.d.ts.map +1 -1
  182. package/cli/dist/commands/list.js +11 -28
  183. package/cli/dist/commands/list.js.map +1 -1
  184. package/cli/dist/commands/mcp.d.ts +48 -0
  185. package/cli/dist/commands/mcp.d.ts.map +1 -0
  186. package/cli/dist/commands/mcp.js +229 -0
  187. package/cli/dist/commands/mcp.js.map +1 -0
  188. package/cli/dist/commands/self-remove.d.ts +7 -0
  189. package/cli/dist/commands/self-remove.d.ts.map +1 -0
  190. package/cli/dist/commands/self-remove.js +179 -0
  191. package/cli/dist/commands/self-remove.js.map +1 -0
  192. package/cli/dist/commands/show.d.ts.map +1 -1
  193. package/cli/dist/commands/show.js +29 -99
  194. package/cli/dist/commands/show.js.map +1 -1
  195. package/cli/dist/commands/skill.d.ts +67 -0
  196. package/cli/dist/commands/skill.d.ts.map +1 -0
  197. package/cli/dist/commands/skill.js +513 -0
  198. package/cli/dist/commands/skill.js.map +1 -0
  199. package/cli/dist/commands/unlink.d.ts +6 -0
  200. package/cli/dist/commands/unlink.d.ts.map +1 -0
  201. package/cli/dist/commands/unlink.js +115 -0
  202. package/cli/dist/commands/unlink.js.map +1 -0
  203. package/cli/dist/commands/validate.d.ts +6 -0
  204. package/cli/dist/commands/validate.d.ts.map +1 -0
  205. package/cli/dist/commands/validate.js +159 -0
  206. package/cli/dist/commands/validate.js.map +1 -0
  207. package/cli/dist/utils/catalog-sync.d.ts +22 -0
  208. package/cli/dist/utils/catalog-sync.d.ts.map +1 -0
  209. package/cli/dist/utils/catalog-sync.js +157 -0
  210. package/cli/dist/utils/catalog-sync.js.map +1 -0
  211. package/cli/dist/utils/character-count.d.ts +56 -0
  212. package/cli/dist/utils/character-count.d.ts.map +1 -0
  213. package/cli/dist/utils/character-count.js +190 -0
  214. package/cli/dist/utils/character-count.js.map +1 -0
  215. package/cli/dist/utils/documentation-validator.d.ts +18 -0
  216. package/cli/dist/utils/documentation-validator.d.ts.map +1 -0
  217. package/cli/dist/utils/documentation-validator.js +233 -0
  218. package/cli/dist/utils/documentation-validator.js.map +1 -0
  219. package/cli/dist/utils/install-rules.d.ts +32 -0
  220. package/cli/dist/utils/install-rules.d.ts.map +1 -0
  221. package/cli/dist/utils/install-rules.js +375 -0
  222. package/cli/dist/utils/install-rules.js.map +1 -0
  223. package/cli/dist/utils/mcp-integration.d.ts +70 -0
  224. package/cli/dist/utils/mcp-integration.d.ts.map +1 -0
  225. package/cli/dist/utils/mcp-integration.js +292 -0
  226. package/cli/dist/utils/mcp-integration.js.map +1 -0
  227. package/cli/dist/utils/module-system.d.ts +153 -0
  228. package/cli/dist/utils/module-system.d.ts.map +1 -0
  229. package/cli/dist/utils/module-system.js +528 -0
  230. package/cli/dist/utils/module-system.js.map +1 -0
  231. package/cli/dist/utils/modules-catalog.d.ts +33 -0
  232. package/cli/dist/utils/modules-catalog.d.ts.map +1 -0
  233. package/cli/dist/utils/modules-catalog.js +163 -0
  234. package/cli/dist/utils/modules-catalog.js.map +1 -0
  235. package/cli/dist/utils/rule-install-hooks.d.ts +19 -0
  236. package/cli/dist/utils/rule-install-hooks.d.ts.map +1 -0
  237. package/cli/dist/utils/rule-install-hooks.js +224 -0
  238. package/cli/dist/utils/rule-install-hooks.js.map +1 -0
  239. package/cli/dist/utils/skill-system.d.ts +95 -0
  240. package/cli/dist/utils/skill-system.d.ts.map +1 -0
  241. package/cli/dist/utils/skill-system.js +313 -0
  242. package/cli/dist/utils/skill-system.js.map +1 -0
  243. package/modules.md +518 -106
  244. package/package.json +12 -3
package/modules.md CHANGED
@@ -1,176 +1,588 @@
1
- # Available Extension Modules
1
+ # Augment Extensions Module Catalog
2
2
 
3
- This document catalogs all available extension modules for Augment Code AI.
3
+ This catalog lists all available extension modules for Augment Code AI.
4
+
5
+ ## Quick Start
6
+
7
+ ```bash
8
+ # List all modules
9
+ augx list
10
+
11
+ # Show module details
12
+ augx show <module-name>
13
+
14
+ # Link a module to your project
15
+ augx link <module-name>
16
+ ```
4
17
 
5
18
  ## Coding Standards
6
19
 
20
+ ### HTML Standards
21
+ - **Module**: `coding-standards/html`
22
+ - **Version**: 1.0.0
23
+ - **Character Count**: ~32,477
24
+ - **Description**: Comprehensive HTML coding standards for semantic, accessible, and modern web development
25
+ - **Contents**:
26
+ - Semantic HTML
27
+ - Accessibility (ARIA, WCAG)
28
+ - Forms and validation
29
+ - SEO best practices
30
+ - Performance optimization
31
+
32
+ **Usage**:
33
+ ```bash
34
+ augx link coding-standards/html
35
+ ```
36
+
37
+ ### CSS Standards
38
+ - **Module**: `coding-standards/css`
39
+ - **Version**: 1.0.0
40
+ - **Character Count**: ~30,556
41
+ - **Description**: Modern CSS coding standards including CSS Grid, Flexbox, custom properties, and responsive design
42
+ - **Contents**:
43
+ - Modern CSS features (Grid, Flexbox, Custom Properties)
44
+ - Responsive design
45
+ - CSS architecture (BEM, SMACSS)
46
+ - Performance optimization
47
+ - Browser compatibility
48
+
49
+ **Usage**:
50
+ ```bash
51
+ augx link coding-standards/css
52
+ ```
53
+
54
+ ### JavaScript Standards
55
+ - **Module**: `coding-standards/js`
56
+ - **Version**: 1.0.0
57
+ - **Character Count**: ~101,818
58
+ - **Description**: ES6+ JavaScript coding standards including async patterns, DOM manipulation, and modern tooling
59
+ - **Contents**:
60
+ - ES6+ features
61
+ - Async patterns (Promises, async/await)
62
+ - DOM manipulation
63
+ - Error handling
64
+ - Performance optimization
65
+ - Modern tooling (ESLint, Prettier)
66
+
67
+ **Usage**:
68
+ ```bash
69
+ augx link coding-standards/js
70
+ ```
71
+
72
+ ### HTML/CSS/JavaScript Standards (DEPRECATED)
73
+ - **Module**: `coding-standards/html-css-js`
74
+ - **Version**: 1.0.0
75
+ - **Character Count**: ~165,097
76
+ - **Status**: ⚠️ **DEPRECATED** - Use individual modules or the `collections/html-css-js` collection instead
77
+ - **Description**: Legacy monolithic module. Replaced by individual HTML, CSS, and JS modules for better flexibility.
78
+ - **Migration**: Use `augx link collections/html-css-js` or link individual modules
79
+
80
+ **Usage** (not recommended):
81
+ ```bash
82
+ augx link coding-standards/html-css-js # Deprecated
83
+ ```
84
+
85
+ ### Python Coding Standards
86
+ - **Module**: `coding-standards/python`
87
+ - **Version**: 1.1.0
88
+ - **Character Count**: ~116,868
89
+ - **Description**: Comprehensive Python coding standards including naming conventions, type hints (PEP 484, 585, 604), and error handling
90
+ - **Contents**:
91
+ - Async patterns
92
+ - Best practices
93
+ - Code organization
94
+ - Documentation
95
+ - Error handling
96
+ - Naming conventions
97
+ - Testing
98
+ - Tooling
99
+ - Type hints
100
+
101
+ **Usage**:
102
+ ```bash
103
+ augx link coding-standards/python
104
+ ```
105
+
106
+ ### React Patterns
107
+ - **Module**: `coding-standards/react`
108
+ - **Version**: 1.0.0
109
+ - **Character Count**: ~32,000
110
+ - **Description**: Modern React patterns including component design, hooks, and state management best practices
111
+ - **Contents**:
112
+ - Component patterns
113
+ - Hooks best practices
114
+ - Performance
115
+ - State management
116
+ - Typescript react
117
+
118
+ **Usage**:
119
+ ```bash
120
+ augx link coding-standards/react
121
+ ```
122
+
7
123
  ### TypeScript Standards
8
124
  - **Module**: `coding-standards/typescript`
9
125
  - **Version**: 1.0.0
10
- - **Character Count**: ~15,420
126
+ - **Character Count**: ~6,416
11
127
  - **Description**: Comprehensive TypeScript coding standards and best practices
12
128
  - **Contents**:
13
129
  - Naming conventions
14
- - Type safety guidelines
15
- - Error handling patterns
16
- - Async/await best practices
17
130
 
18
131
  **Usage**:
19
132
  ```bash
20
133
  augx link coding-standards/typescript
21
134
  ```
22
135
 
23
- ### Python Standards (Coming Soon)
24
- - **Module**: `coding-standards/python`
25
- - **Status**: Planned
26
-
27
- ### React Patterns (Coming Soon)
28
- - **Module**: `coding-standards/react`
29
- - **Status**: Planned
136
+ ### PHP Coding Standards
137
+ - **Module**: `coding-standards/php`
138
+ - **Version**: 1.0.0
139
+ - **Character Count**: ~186,539
140
+ - **Description**: Comprehensive PHP coding standards following PSR standards and modern PHP best practices across various project types including web applications, APIs, CLI tools, CMS integrations, e-commerce systems, and legacy migrations
141
+ - **Contents**:
142
+ - PSR standards (PSR-1, PSR-12, PSR-4, PSR-7, PSR-11)
143
+ - Naming conventions
144
+ - Type declarations
145
+ - Error handling
146
+ - Security (OWASP guidelines)
147
+ - Performance optimization
148
+ - Testing standards
149
+ - Documentation (PHPDoc)
150
+ - Code quality tools
151
+ - Category configuration
152
+ - Web applications
153
+ - API development
154
+ - CLI tools
155
+ - CMS integration (WordPress, Drupal)
156
+ - E-commerce (WooCommerce)
157
+ - Legacy migration
30
158
 
31
- ## Workflows
159
+ **Usage**:
160
+ ```bash
161
+ augx link coding-standards/php
162
+ ```
32
163
 
33
- ### OpenSpec Workflow
34
- - **Module**: `workflows/openspec`
164
+ ### PowerShell Coding Standards
165
+ - **Module**: `coding-standards/powershell`
35
166
  - **Version**: 1.0.0
36
- - **Character Count**: ~30,505
37
- - **Description**: Spec-driven development (SDD) workflow for AI coding assistants
167
+ - **Character Count**: ~162,000
168
+ - **Description**: Comprehensive PowerShell coding standards for professional, maintainable, and secure PowerShell code across automation, modules, DSC, cloud orchestration, administrative tools, cross-platform scripts, and legacy migrations
38
169
  - **Contents**:
39
- - Complete workflow guide (proposal specs tasks → implement → archive)
40
- - Specification format and delta syntax
41
- - Manual setup without CLI
42
- - CLI command reference
43
- - Best practices and patterns
44
- - Complete change examples
170
+ - Universal standards (naming, error handling, security, performance, testing)
171
+ - Configuration schema documentation (.augment/powershell-config.json)
172
+ - Automation scripts (scheduled tasks, event-driven automation)
173
+ - PowerShell modules and advanced functions
174
+ - Desired State Configuration (DSC)
175
+ - Cloud orchestration (Azure, AWS)
176
+ - Administrative tools (Active Directory, Exchange, SQL Server)
177
+ - Cross-platform scripts (PowerShell Core compatibility)
178
+ - Legacy migrations (Windows PowerShell to PowerShell Core)
179
+ - Category configuration system
180
+ - PSScriptAnalyzer integration
181
+ - Pester testing framework
45
182
 
46
183
  **Usage**:
47
184
  ```bash
48
- augx link workflows/openspec
185
+ augx link coding-standards/powershell
186
+ ```
187
+
188
+ **Configuration** (`.augment/powershell-config.json`):
189
+ ```json
190
+ {
191
+ "powershell_categories": ["automation", "modules", "cloud"],
192
+ "powershell_version": "7.4",
193
+ "strict_mode": true,
194
+ "static_analysis": {
195
+ "tool": "PSScriptAnalyzer",
196
+ "severity": "Warning"
197
+ },
198
+ "testing": {
199
+ "framework": "Pester",
200
+ "version": "5.x"
201
+ }
202
+ }
203
+ ```
204
+
205
+ ## Collections
206
+
207
+ Collections bundle multiple related modules together for easier installation.
208
+
209
+ ### HTML/CSS/JS Frontend Collection
210
+ - **Collection**: `collections/html-css-js`
211
+ - **Version**: 1.0.0
212
+ - **Description**: Complete frontend development standards bundle including HTML, CSS, and JavaScript modules
213
+ - **Included Modules**:
214
+ - `coding-standards/html` (v1.0.0) - HTML standards
215
+ - `coding-standards/css` (v1.0.0) - CSS standards
216
+ - `coding-standards/js` (v1.0.0) - JavaScript standards
217
+ - **Total Character Count**: ~164,851
218
+ - **Backward Compatibility**: Replaces the deprecated `coding-standards/html-css-js` module
219
+
220
+ **Usage**:
221
+ ```bash
222
+ augx link collections/html-css-js
49
223
  ```
50
224
 
51
- **Installation**: Optional CLI available via `npm install -g @fission-ai/openspec@latest`
225
+ **Or link individual modules**:
226
+ ```bash
227
+ augx link coding-standards/html
228
+ augx link coding-standards/css
229
+ augx link coding-standards/js
230
+ ```
52
231
 
53
- **Learn More**: https://openspec.dev/
232
+ ## Domain Rules
54
233
 
55
- ### WordPress Plugin Development Workflow
56
- - **Module**: `workflows/wordpress-plugin`
57
- - **Version**: 1.2.0
58
- - **Character Count**: ~81,564
59
- - **Description**: Complete workflows for WordPress plugin development including development cycle, testing setup, WordPress.org submission, and comprehensive best practices. Optimized for AI-assisted development with OpenSpec and Beads integration.
234
+ ### API Design Guidelines
235
+ - **Module**: `domain-rules/api-design`
236
+ - **Version**: 1.0.0
237
+ - **Character Count**: ~35,000
238
+ - **Description**: Comprehensive API design guidelines including REST, GraphQL, versioning, and best practices
60
239
  - **Contents**:
61
- - Development workflow (feature planning, implementation, security-first approach)
62
- - Testing workflow (PHPUnit setup, TDD, CI/CD integration)
63
- - Submission workflow (security audit, WPCS compliance, WordPress.org submission)
64
- - Best practices (code organization, naming conventions, security, performance, accessibility)
65
- - AI prompt templates for each workflow phase
66
- - Beads task breakdown patterns
67
- - OpenSpec spec templates
240
+ - Authentication
241
+ - Documentation
242
+ - Error handling
243
+ - Graphql api
244
+ - Rest api
245
+ - Versioning
68
246
 
69
247
  **Usage**:
70
248
  ```bash
71
- augx link workflows/wordpress-plugin
249
+ augx link domain-rules/api-design
72
250
  ```
73
251
 
74
- **Dependencies**: `domain-rules/wordpress-plugin`
252
+ ### Database Design Guidelines
253
+ - **Module**: `domain-rules/database`
254
+ - **Version**: 1.0.0
255
+ - **Character Count**: ~449,449
256
+ - **Description**: Comprehensive database design guidelines including schema design, normalization, indexing, and best practices
257
+ - **Contents**:
258
+ - Flat databases
259
+ - Nosql databases
260
+ - Nosql document stores
261
+ - Nosql graph databases
262
+ - Nosql key value stores
263
+ - Performance optimization
264
+ - Relational databases
265
+ - Relational indexing
266
+ - Relational query optimization
267
+ - Relational schema design
268
+ - Relational transactions
269
+ - Security standards
270
+ - Universal best practices
271
+ - Vector databases
272
+ - Vector embeddings
273
+ - Vector indexing
75
274
 
275
+ **Usage**:
276
+ ```bash
277
+ augx link domain-rules/database
278
+ ```
76
279
 
77
- ### Beads Workflow
78
- - **Module**: `workflows/beads`
280
+ ### Model Context Protocol (MCP) Guidelines
281
+ - **Module**: `domain-rules/mcp`
79
282
  - **Version**: 1.0.0
80
- - **Character Count**: ~36,816
81
- - **Description**: Distributed, git-backed graph issue tracker for AI agents
283
+ - **Character Count**: ~219,130
284
+ - **Description**: Comprehensive guidelines for designing and implementing Model Context Protocol systems including token-based, state-based, vector-based, hybrid, graph-augmented, and compressed MCP
82
285
  - **Contents**:
83
- - Complete workflow guide (create dependencies ready work → close)
84
- - JSONL file format specification
85
- - Manual setup without CLI
86
- - CLI command reference
87
- - Best practices and patterns
88
- - Complete workflow examples
286
+ - Universal rules (context optimization, error handling, security, monitoring, testing, documentation)
287
+ - Token-based MCP (compression, chunking, budgeting)
288
+ - State-based MCP (persistence, state machines, concurrency)
289
+ - Vector-based MCP (RAG, embeddings, semantic search)
290
+ - Hybrid MCP (multi-memory coordination, context orchestration)
291
+ - Graph-augmented MCP (knowledge graphs, entity relationships, graph traversal)
292
+ - Compressed MCP (multi-stage compression, mobile optimization)
293
+ - Configuration system (JSON schema, validation, override semantics)
294
+ - Testing framework (unit, integration, synthetic testing)
295
+ - 6 complete implementation examples with code
89
296
 
90
297
  **Usage**:
91
298
  ```bash
92
- augx link workflows/beads
299
+ augx link domain-rules/mcp
93
300
  ```
94
301
 
95
- **Installation**: Optional CLI available via `npm install -g @beads/bd`
302
+ ### Security Guidelines
303
+ - **Module**: `domain-rules/security`
304
+ - **Version**: 1.0.0
305
+ - **Character Count**: ~38,000
306
+ - **Description**: Comprehensive security guidelines including OWASP best practices, authentication, encryption, and secure coding
307
+ - **Contents**:
308
+ - Authentication security
309
+ - Encryption
310
+ - Input validation
311
+ - Owasp top 10
312
+ - Secure coding
313
+ - Web security
96
314
 
97
- **Learn More**: https://github.com/steveyegge/beads
315
+ **Usage**:
316
+ ```bash
317
+ augx link domain-rules/security
318
+ ```
98
319
 
99
- ## Domain Rules
320
+ ### WordPress Development Standards
321
+ - **Module**: `domain-rules/wordpress`
322
+ - **Version**: 1.0.0
323
+ - **Character Count**: ~0
324
+ - **Description**: Comprehensive WordPress development guidelines including themes, plugins, blocks, and best practices
325
+ - **Contents**:
326
+ - Coding standards
327
+ - Directory structure
328
+ - File patterns
329
+ - Gutenberg blocks
330
+ - Performance
331
+ - Plugin development
332
+ - Project detection
333
+ - Rest api
334
+ - Security
335
+ - Theme development
336
+ - Woocommerce
337
+
338
+ **Usage**:
339
+ ```bash
340
+ augx link domain-rules/wordpress
341
+ ```
100
342
 
101
343
  ### WordPress Plugin Development
102
344
  - **Module**: `domain-rules/wordpress-plugin`
103
345
  - **Version**: 1.1.0
104
346
  - **Character Count**: ~344,186
105
- - **Description**: Comprehensive WordPress plugin development guidelines covering plugin structure, architecture patterns, admin interfaces, frontend functionality, Gutenberg blocks, REST API, AJAX, database management, security, performance, WooCommerce integration, testing patterns, and WordPress.org submission
106
- - **Contents**:
107
- - Plugin structure and architecture patterns (7 patterns)
108
- - Activation/deactivation/uninstall hooks
109
- - Admin interface development (settings pages, meta boxes)
110
- - Frontend functionality (CPT, taxonomies, shortcodes, widgets)
111
- - Gutenberg block development
112
- - REST API endpoints
113
- - AJAX handlers
114
- - Database management (custom tables, queries)
115
- - Cron jobs and scheduled tasks
116
- - Security best practices (nonces, sanitization, escaping)
117
- - Performance optimization (caching, query optimization)
118
- - Internationalization (i18n/l10n)
119
- - Asset management (scripts and styles)
120
- - WooCommerce integration (products, cart, checkout, orders, payment gateways, emails)
121
- - Testing patterns (PHPUnit, unit tests, integration tests, WooCommerce tests)
122
- - Documentation standards (PHPDoc, readme.txt)
123
- - WordPress.org submission process
124
- - **Simple Procedural Plugin Example** (complete working plugin)
347
+ - **Description**: Comprehensive WordPress plugin development guidelines covering plugin structure, architecture patterns, admin interfaces, frontend functionality, Gutenberg blocks, REST API, AJAX, database management, security, performance, WooCommerce integration, testing patterns, and WordPress.org submission.
348
+ - **Contents**:
349
+ - Activation hooks
350
+ - Admin interface
351
+ - Ajax handlers
352
+ - Asset management
353
+ - Context providers
354
+ - Cron jobs
355
+ - Database management
356
+ - Documentation standards
357
+ - Frontend functionality
358
+ - Gutenberg blocks
359
+ - Internationalization
360
+ - Migration
361
+ - Performance optimization
362
+ - Plugin architecture
363
+ - Plugin structure
364
+ - Rest api
365
+ - Scaffolding workflow
366
+ - Security best practices
367
+ - Testing patterns
368
+ - Testing
369
+ - Vscode integration
370
+ - Woocommerce integration
371
+ - Wordpress org submission
125
372
 
126
373
  **Usage**:
127
374
  ```bash
128
375
  augx link domain-rules/wordpress-plugin
129
376
  ```
130
377
 
131
- ### Web Development (Coming Soon)
132
- - **Module**: `domain-rules/web-development`
133
- - **Status**: Planned
134
- - **Description**: Best practices for web application development
378
+ ## Workflows
135
379
 
136
- ### API Design (Coming Soon)
137
- - **Module**: `domain-rules/api-design`
138
- - **Status**: Planned
139
- - **Description**: RESTful and GraphQL API design guidelines
380
+ ### Beads Workflow
381
+ - **Module**: `workflows/beads`
382
+ - **Version**: 1.0.0
383
+ - **Character Count**: ~39,912
384
+ - **Description**: Distributed, git-backed graph issue tracker for AI agents. Provides persistent, structured memory for coding agents with dependency tracking.
385
+ - **Contents**:
386
+ - Best practices
387
+ - File format
388
+ - Manual setup
389
+ - Workflow
140
390
 
141
- ### Security (Coming Soon)
142
- - **Module**: `domain-rules/security`
143
- - **Status**: Planned
144
- - **Description**: Security best practices and common vulnerabilities
391
+ **Usage**:
392
+ ```bash
393
+ augx link workflows/beads
394
+ ```
395
+
396
+ ### OpenSpec Workflow
397
+ - **Module**: `workflows/openspec`
398
+ - **Version**: 1.0.0
399
+ - **Character Count**: ~32,661
400
+ - **Description**: Spec-driven development (SDD) workflow for AI coding assistants. Provides structured change management with proposals, specs, and tasks.
401
+ - **Contents**:
402
+ - Best practices
403
+ - Manual setup
404
+ - Spec format
405
+ - Workflow
406
+
407
+ **Usage**:
408
+ ```bash
409
+ augx link workflows/openspec
410
+ ```
145
411
 
146
412
  ## Examples
147
413
 
148
- ### Design Patterns (Coming Soon)
414
+ ### Design Patterns Examples
149
415
  - **Module**: `examples/design-patterns`
150
- - **Status**: Planned
151
- - **Description**: Common design patterns with code examples
416
+ - **Version**: 1.0.0
417
+ - **Character Count**: ~42,000
418
+ - **Description**: Common design patterns with TypeScript/JavaScript implementations and use cases
152
419
 
153
- ### Testing Strategies (Coming Soon)
154
- - **Module**: `examples/testing-strategies`
155
- - **Status**: Planned
156
- - **Description**: Unit, integration, and E2E testing examples
420
+ **Usage**:
421
+ ```bash
422
+ augx link examples/design-patterns
423
+ ```
157
424
 
158
- ## Contributing New Modules
425
+ ### Gutenberg Block Plugin Examples
426
+ - **Module**: `examples/gutenberg-block-plugin`
427
+ - **Version**: 1.0.0
428
+ - **Character Count**: ~15,889
429
+ - **Description**: Complete Gutenberg block plugin examples with block.json, React components, InspectorControls, RichText, MediaUpload, and build process
159
430
 
160
- See [module-development.md](./module-development.md) for guidelines on creating new modules.
431
+ **Usage**:
432
+ ```bash
433
+ augx link examples/gutenberg-block-plugin
434
+ ```
435
+
436
+ ### REST API Plugin Examples
437
+ - **Module**: `examples/rest-api-plugin`
438
+ - **Version**: 1.0.0
439
+ - **Character Count**: ~40,367
440
+ - **Description**: Complete REST API plugin examples with custom endpoints (GET, POST, PUT, DELETE), authentication, validation, error handling, and JavaScript client examples
441
+
442
+ **Usage**:
443
+ ```bash
444
+ augx link examples/rest-api-plugin
445
+ ```
446
+
447
+ ### WooCommerce Extension Examples
448
+ - **Module**: `examples/woocommerce-extension`
449
+ - **Version**: 1.0.0
450
+ - **Character Count**: ~24,196
451
+ - **Description**: Complete WooCommerce extension examples with custom product fields, checkout customization, payment gateway, order hooks, and WooCommerce best practices
452
+
453
+ **Usage**:
454
+ ```bash
455
+ augx link examples/woocommerce-extension
456
+ ```
457
+
458
+ ## Skills System
459
+
460
+ ### Overview
461
+ - **Location**: `skills/`
462
+ - **Version**: 1.0.0
463
+ - **Total Skills**: 4
464
+ - **Description**: Token-efficient skill-based system for on-demand AI context injection. Skills are lightweight, focused definitions that replace full modules for specific tasks.
465
+
466
+ ### Key Features
467
+ - **Token Reduction**: 97.18% average reduction vs full modules
468
+ - **Dynamic Loading**: Load only what you need, when you need it
469
+ - **Dependency Resolution**: Automatic dependency management
470
+ - **CLI Integration**: Wrap MCP servers and external tools
471
+ - **Caching**: Intelligent caching for performance
472
+
473
+ ### Skill Categories
474
+
475
+ #### Retrieval Skills
476
+ - **sdk-query**: Query SDK documentation and code examples
477
+ - **context-retrieval**: Retrieve code context using semantic search
478
+
479
+ #### Analysis Skills
480
+ - **code-analysis**: Analyze code for quality and patterns
481
+
482
+ #### Generation Skills
483
+ - **add-mcp-skill**: Generate new MCP-based skills
484
+
485
+ ### Usage
486
+
487
+ ```bash
488
+ # List available skills
489
+ augx skill list
490
+
491
+ # Show skill details
492
+ augx skill show sdk-query
493
+
494
+ # Inject skill into context
495
+ augx skill inject sdk-query
496
+
497
+ # Load multiple skills
498
+ augx skill load sdk-query context-retrieval
499
+
500
+ # Validate a skill
501
+ augx skill validate skills/retrieval/my-skill.md
502
+
503
+ # Cache management
504
+ augx skill cache-clear
505
+ augx skill cache-stats
506
+ ```
507
+
508
+ ### Token Budget Guidelines
509
+ - **Micro skills**: 500-1000 tokens (single focused task)
510
+ - **Small skills**: 1000-2000 tokens (simple functionality)
511
+ - **Medium skills**: 2000-5000 tokens (moderate complexity)
512
+ - **Large skills**: 5000-10000 tokens (complex functionality)
513
+
514
+ ### Performance Benchmarks
515
+
516
+ Based on `benchmarks/results.json`:
517
+
518
+ | Scenario | Baseline Tokens | Skill Tokens | Reduction |
519
+ |----------|----------------|--------------|-----------|
520
+ | SDK Query | 27,706 | 804 | 97.10% |
521
+ | Context Retrieval | 27,706 | 1,021 | 96.31% |
522
+ | Multiple Skills | 27,706 | 1,825 | 93.41% |
523
+ | Workflow Task | 8,804 | 8 | 99.91% |
524
+ | Coding Standards | 1,440 | 12 | 99.17% |
525
+ | **Average** | - | - | **97.18%** |
526
+
527
+ ### Creating New Skills
528
+
529
+ See `skills/README.md` for detailed instructions on creating new skills.
530
+
531
+ **Quick Start**:
532
+ 1. Choose appropriate category
533
+ 2. Create skill file: `skills/<category>/<skill-id>.md`
534
+ 3. Follow skill.md schema
535
+ 4. Keep within token budget (500-10k tokens)
536
+ 5. Test with `augx skill validate <skill-id>`
537
+
538
+ **Automated MCP Skill Creation**:
539
+ ```bash
540
+ # Create a new MCP skill automatically
541
+ augx skill create-mcp \
542
+ --name "GitHub MCP" \
543
+ --description "GitHub repository management" \
544
+ --category "integration" \
545
+ --package "@modelcontextprotocol/server-github" \
546
+ --token-budget 2500 \
547
+ --tags "github,repository"
548
+ ```
549
+
550
+ ### MCP Integration
551
+
552
+ The skills system integrates with Model Context Protocol (MCP) servers:
553
+
554
+ ```bash
555
+ # List MCP servers
556
+ augx mcp list
557
+
558
+ # Add MCP server
559
+ augx mcp add github-mcp "npx -y @modelcontextprotocol/server-github"
560
+
561
+ # Execute MCP tool
562
+ augx mcp exec github-mcp search-repos --args '{"query": "augment"}'
563
+
564
+ # Generate skill wrapper for MCP tool
565
+ augx mcp wrap github-mcp search-repos github-search --category retrieval
566
+ ```
161
567
 
162
- ## Module Versioning
568
+ ### Meta-Skills
163
569
 
164
- All modules follow [Semantic Versioning](https://semver.org/):
165
- - **MAJOR**: Breaking changes to module structure or rules
166
- - **MINOR**: New rules or examples added
167
- - **PATCH**: Bug fixes, typos, clarifications
570
+ **Meta-skills** are skills that help create or manage other skills:
168
571
 
169
- ## Character Count Guidelines
572
+ - **add-mcp-skill**: Automates onboarding of new MCP integrations
573
+ - Generates skill files from templates
574
+ - Validates skill structure
575
+ - Updates documentation
576
+ - Reduces skill creation time from 30+ minutes to < 1 minute
170
577
 
171
- - **Small modules**: < 10,000 characters
172
- - **Medium modules**: 10,000 - 25,000 characters
173
- - **Large modules**: > 25,000 characters
578
+ ---
174
579
 
175
- Modules should be split if they exceed 50,000 characters.
580
+ ## Statistics
176
581
 
582
+ - **Total Modules**: 18
583
+ - **Coding Standards**: 5
584
+ - **Domain Rules**: 5
585
+ - **Workflows**: 2
586
+ - **Examples**: 4
587
+ - **Total Skills**: 4
588
+ - **Total Character Count**: ~1,774,692