@softspark/ai-toolkit 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 (327) hide show
  1. package/AGENTS.md +412 -0
  2. package/CHANGELOG.md +68 -0
  3. package/LICENSE +21 -0
  4. package/README.md +632 -0
  5. package/action.yml +53 -0
  6. package/app/.claude-plugin/plugin.json +44 -0
  7. package/app/ARCHITECTURE.md +306 -0
  8. package/app/CLAUDE.md.template +23 -0
  9. package/app/agents/ai-engineer.md +128 -0
  10. package/app/agents/backend-specialist.md +193 -0
  11. package/app/agents/business-intelligence.md +54 -0
  12. package/app/agents/chaos-monkey.md +67 -0
  13. package/app/agents/chief-of-staff.md +51 -0
  14. package/app/agents/code-archaeologist.md +127 -0
  15. package/app/agents/code-reviewer.md +184 -0
  16. package/app/agents/command-expert.md +131 -0
  17. package/app/agents/data-analyst.md +205 -0
  18. package/app/agents/data-scientist.md +151 -0
  19. package/app/agents/database-architect.md +317 -0
  20. package/app/agents/debugger.md +238 -0
  21. package/app/agents/devops-implementer.md +194 -0
  22. package/app/agents/documenter.md +364 -0
  23. package/app/agents/explorer-agent.md +145 -0
  24. package/app/agents/fact-checker.md +172 -0
  25. package/app/agents/frontend-specialist.md +209 -0
  26. package/app/agents/game-developer.md +216 -0
  27. package/app/agents/incident-responder.md +226 -0
  28. package/app/agents/infrastructure-architect.md +127 -0
  29. package/app/agents/infrastructure-validator.md +247 -0
  30. package/app/agents/llm-ops-engineer.md +237 -0
  31. package/app/agents/mcp-expert.md +228 -0
  32. package/app/agents/mcp-server-architect.md +195 -0
  33. package/app/agents/mcp-testing-engineer.md +292 -0
  34. package/app/agents/meta-architect.md +58 -0
  35. package/app/agents/ml-engineer.md +136 -0
  36. package/app/agents/mobile-developer.md +190 -0
  37. package/app/agents/night-watchman.md +55 -0
  38. package/app/agents/nlp-engineer.md +154 -0
  39. package/app/agents/orchestrator.md +437 -0
  40. package/app/agents/performance-optimizer.md +254 -0
  41. package/app/agents/predictive-analyst.md +57 -0
  42. package/app/agents/product-manager.md +194 -0
  43. package/app/agents/project-planner.md +287 -0
  44. package/app/agents/prompt-engineer.md +103 -0
  45. package/app/agents/qa-automation-engineer.md +182 -0
  46. package/app/agents/rag-engineer.md +201 -0
  47. package/app/agents/research-synthesizer.md +138 -0
  48. package/app/agents/search-specialist.md +101 -0
  49. package/app/agents/security-architect.md +62 -0
  50. package/app/agents/security-auditor.md +293 -0
  51. package/app/agents/seo-specialist.md +111 -0
  52. package/app/agents/system-governor.md +57 -0
  53. package/app/agents/tech-lead.md +62 -0
  54. package/app/agents/technical-researcher.md +103 -0
  55. package/app/agents/test-engineer.md +264 -0
  56. package/app/constitution.md +38 -0
  57. package/app/hooks/_profile-check.sh +11 -0
  58. package/app/hooks/guard-destructive.sh +74 -0
  59. package/app/hooks/guard-path.sh +73 -0
  60. package/app/hooks/post-tool-use.sh +35 -0
  61. package/app/hooks/pre-compact.sh +31 -0
  62. package/app/hooks/quality-check.sh +22 -0
  63. package/app/hooks/quality-gate.sh +49 -0
  64. package/app/hooks/save-session.sh +24 -0
  65. package/app/hooks/session-end.sh +37 -0
  66. package/app/hooks/session-start.sh +29 -0
  67. package/app/hooks/subagent-start.sh +16 -0
  68. package/app/hooks/subagent-stop.sh +16 -0
  69. package/app/hooks/track-usage.sh +50 -0
  70. package/app/hooks/user-prompt-submit.sh +25 -0
  71. package/app/hooks.json +178 -0
  72. package/app/mcp-defaults.json +23 -0
  73. package/app/output-styles/golden-rules.md +43 -0
  74. package/app/plugins/README.md +19 -0
  75. package/app/plugins/csharp-pack/README.md +11 -0
  76. package/app/plugins/csharp-pack/plugin.json +18 -0
  77. package/app/plugins/enterprise-pack/README.md +16 -0
  78. package/app/plugins/enterprise-pack/hooks/output-style.sh +6 -0
  79. package/app/plugins/enterprise-pack/hooks/status-line.sh +8 -0
  80. package/app/plugins/enterprise-pack/plugin.json +24 -0
  81. package/app/plugins/frontend-pack/README.md +14 -0
  82. package/app/plugins/frontend-pack/plugin.json +22 -0
  83. package/app/plugins/java-pack/README.md +11 -0
  84. package/app/plugins/java-pack/plugin.json +18 -0
  85. package/app/plugins/kotlin-pack/README.md +11 -0
  86. package/app/plugins/kotlin-pack/plugin.json +18 -0
  87. package/app/plugins/memory-pack/README.md +24 -0
  88. package/app/plugins/memory-pack/hooks/observation-capture.sh +67 -0
  89. package/app/plugins/memory-pack/hooks/session-summary.sh +71 -0
  90. package/app/plugins/memory-pack/plugin.json +22 -0
  91. package/app/plugins/memory-pack/scripts/init_db.py +81 -0
  92. package/app/plugins/memory-pack/scripts/strip_private.py +22 -0
  93. package/app/plugins/memory-pack/skills/mem-search/SKILL.md +70 -0
  94. package/app/plugins/research-pack/README.md +14 -0
  95. package/app/plugins/research-pack/plugin.json +22 -0
  96. package/app/plugins/ruby-pack/README.md +11 -0
  97. package/app/plugins/ruby-pack/plugin.json +18 -0
  98. package/app/plugins/rust-pack/README.md +11 -0
  99. package/app/plugins/rust-pack/plugin.json +18 -0
  100. package/app/plugins/security-pack/README.md +15 -0
  101. package/app/plugins/security-pack/plugin.json +23 -0
  102. package/app/plugins/swift-pack/README.md +11 -0
  103. package/app/plugins/swift-pack/plugin.json +18 -0
  104. package/app/rules/claude-toolkit-rules.md +21 -0
  105. package/app/rules/git-conventions.md +5 -0
  106. package/app/rules/quality-gates.md +10 -0
  107. package/app/skills/_lib/__init__.py +1 -0
  108. package/app/skills/_lib/detect_utils.py +150 -0
  109. package/app/skills/agent-creator/SKILL.md +82 -0
  110. package/app/skills/analyze/SKILL.md +92 -0
  111. package/app/skills/analyze/scripts/complexity.py +165 -0
  112. package/app/skills/api-patterns/SKILL.md +305 -0
  113. package/app/skills/app-builder/SKILL.md +187 -0
  114. package/app/skills/architecture-audit/SKILL.md +141 -0
  115. package/app/skills/architecture-decision/SKILL.md +55 -0
  116. package/app/skills/architecture-decision/templates/adr-template.md +36 -0
  117. package/app/skills/biz-scan/SKILL.md +30 -0
  118. package/app/skills/briefing/SKILL.md +27 -0
  119. package/app/skills/build/SKILL.md +97 -0
  120. package/app/skills/build/scripts/detect-build.py +151 -0
  121. package/app/skills/chaos/SKILL.md +32 -0
  122. package/app/skills/ci/SKILL.md +77 -0
  123. package/app/skills/ci/scripts/ci-detect.py +135 -0
  124. package/app/skills/ci/templates/github-actions-node.yml +38 -0
  125. package/app/skills/ci/templates/github-actions-python.yml +42 -0
  126. package/app/skills/ci-cd-patterns/SKILL.md +299 -0
  127. package/app/skills/clean-code/SKILL.md +110 -0
  128. package/app/skills/clean-code/reference/dart.md +18 -0
  129. package/app/skills/clean-code/reference/go.md +23 -0
  130. package/app/skills/clean-code/reference/php.md +32 -0
  131. package/app/skills/clean-code/reference/python.md +180 -0
  132. package/app/skills/clean-code/reference/typescript.md +26 -0
  133. package/app/skills/command-creator/SKILL.md +83 -0
  134. package/app/skills/commit/SKILL.md +98 -0
  135. package/app/skills/commit/scripts/pre-commit-check.py +87 -0
  136. package/app/skills/commit/templates/conventional-commit.md +52 -0
  137. package/app/skills/csharp-patterns/SKILL.md +450 -0
  138. package/app/skills/database-patterns/SKILL.md +297 -0
  139. package/app/skills/debug/SKILL.md +154 -0
  140. package/app/skills/debug/scripts/error-parser.py +187 -0
  141. package/app/skills/debugging-tactics/SKILL.md +136 -0
  142. package/app/skills/deploy/SKILL.md +130 -0
  143. package/app/skills/deploy/scripts/pre_deploy_check.py +171 -0
  144. package/app/skills/deploy/templates/deployment-checklist.md +31 -0
  145. package/app/skills/design-an-interface/SKILL.md +105 -0
  146. package/app/skills/design-engineering/SKILL.md +260 -0
  147. package/app/skills/docker-devops/SKILL.md +303 -0
  148. package/app/skills/docs/SKILL.md +145 -0
  149. package/app/skills/docs/scripts/doc-inventory.py +176 -0
  150. package/app/skills/docs/templates/adr-template.md +36 -0
  151. package/app/skills/docs/templates/readme-template.md +67 -0
  152. package/app/skills/documentation-standards/SKILL.md +191 -0
  153. package/app/skills/ecommerce-patterns/SKILL.md +209 -0
  154. package/app/skills/evaluate/SKILL.md +132 -0
  155. package/app/skills/evolve/SKILL.md +27 -0
  156. package/app/skills/explain/SKILL.md +54 -0
  157. package/app/skills/explain/scripts/dependency-graph.py +215 -0
  158. package/app/skills/explore/SKILL.md +112 -0
  159. package/app/skills/explore/scripts/visualize.py +117 -0
  160. package/app/skills/fix/SKILL.md +78 -0
  161. package/app/skills/fix/scripts/error-classifier.py +191 -0
  162. package/app/skills/flutter-patterns/SKILL.md +254 -0
  163. package/app/skills/git-mastery/SKILL.md +70 -0
  164. package/app/skills/grill-me/SKILL.md +38 -0
  165. package/app/skills/health/SKILL.md +91 -0
  166. package/app/skills/health/scripts/health_check.py +162 -0
  167. package/app/skills/hive-mind/SKILL.md +56 -0
  168. package/app/skills/hook-creator/SKILL.md +107 -0
  169. package/app/skills/index/SKILL.md +74 -0
  170. package/app/skills/instinct-review/SKILL.md +77 -0
  171. package/app/skills/java-patterns/SKILL.md +442 -0
  172. package/app/skills/kotlin-patterns/SKILL.md +446 -0
  173. package/app/skills/lint/SKILL.md +103 -0
  174. package/app/skills/lint/scripts/detect-linters.py +112 -0
  175. package/app/skills/mcp-patterns/SKILL.md +270 -0
  176. package/app/skills/mem-search/SKILL.md +70 -0
  177. package/app/skills/migrate/SKILL.md +90 -0
  178. package/app/skills/migrate/scripts/migration-status.py +195 -0
  179. package/app/skills/migration-patterns/SKILL.md +260 -0
  180. package/app/skills/night-watch/SKILL.md +28 -0
  181. package/app/skills/observability-patterns/SKILL.md +203 -0
  182. package/app/skills/onboard/SKILL.md +76 -0
  183. package/app/skills/orchestrate/SKILL.md +86 -0
  184. package/app/skills/panic/SKILL.md +30 -0
  185. package/app/skills/performance-profiling/SKILL.md +59 -0
  186. package/app/skills/plan/SKILL.md +110 -0
  187. package/app/skills/plan/templates/plan-template.md +40 -0
  188. package/app/skills/plan-writing/SKILL.md +201 -0
  189. package/app/skills/plugin-creator/SKILL.md +78 -0
  190. package/app/skills/pr/SKILL.md +129 -0
  191. package/app/skills/pr/scripts/pr-summary.py +175 -0
  192. package/app/skills/prd-to-issues/SKILL.md +108 -0
  193. package/app/skills/prd-to-plan/SKILL.md +120 -0
  194. package/app/skills/predict/SKILL.md +30 -0
  195. package/app/skills/qa-session/SKILL.md +110 -0
  196. package/app/skills/rag-patterns/SKILL.md +203 -0
  197. package/app/skills/refactor/SKILL.md +124 -0
  198. package/app/skills/refactor/scripts/refactor-scan.py +210 -0
  199. package/app/skills/refactor-plan/SKILL.md +112 -0
  200. package/app/skills/repeat/SKILL.md +149 -0
  201. package/app/skills/research-mastery/SKILL.md +56 -0
  202. package/app/skills/review/SKILL.md +141 -0
  203. package/app/skills/review/scripts/diff-analyzer.py +170 -0
  204. package/app/skills/rollback/SKILL.md +87 -0
  205. package/app/skills/rollback/scripts/rollback_info.py +149 -0
  206. package/app/skills/ruby-patterns/SKILL.md +454 -0
  207. package/app/skills/rust-patterns/SKILL.md +446 -0
  208. package/app/skills/search/SKILL.md +64 -0
  209. package/app/skills/security-patterns/SKILL.md +91 -0
  210. package/app/skills/security-patterns/reference/authentication.md +37 -0
  211. package/app/skills/security-patterns/reference/authorization.md +22 -0
  212. package/app/skills/security-patterns/reference/input-validation.md +30 -0
  213. package/app/skills/security-patterns/reference/oauth-csrf-audit.md +131 -0
  214. package/app/skills/skill-creator/SKILL.md +154 -0
  215. package/app/skills/skill-creator/templates/dashboard/index.html +130 -0
  216. package/app/skills/skill-creator/templates/reasoning-engine/assets/example.json +12 -0
  217. package/app/skills/skill-creator/templates/reasoning-engine/search.py +110 -0
  218. package/app/skills/subagent-development/SKILL.md +225 -0
  219. package/app/skills/subagent-development/reference/code-quality-reviewer-prompt.md +145 -0
  220. package/app/skills/subagent-development/reference/implementer-prompt.md +118 -0
  221. package/app/skills/subagent-development/reference/spec-reviewer-prompt.md +100 -0
  222. package/app/skills/swarm/SKILL.md +81 -0
  223. package/app/skills/swift-patterns/SKILL.md +500 -0
  224. package/app/skills/tdd/SKILL.md +174 -0
  225. package/app/skills/tdd/reference/deep-modules.md +32 -0
  226. package/app/skills/tdd/reference/interface-design.md +32 -0
  227. package/app/skills/tdd/reference/mocking.md +52 -0
  228. package/app/skills/tdd/reference/refactoring.md +10 -0
  229. package/app/skills/tdd/reference/tests.md +59 -0
  230. package/app/skills/teams/SKILL.md +101 -0
  231. package/app/skills/test/SKILL.md +107 -0
  232. package/app/skills/test/scripts/detect-runner.py +113 -0
  233. package/app/skills/testing-patterns/SKILL.md +73 -0
  234. package/app/skills/testing-patterns/reference/flutter-testing.md +33 -0
  235. package/app/skills/testing-patterns/reference/go-testing.md +52 -0
  236. package/app/skills/testing-patterns/reference/php-phpunit.md +39 -0
  237. package/app/skills/testing-patterns/reference/python-pytest.md +228 -0
  238. package/app/skills/testing-patterns/reference/typescript-vitest.md +50 -0
  239. package/app/skills/triage-issue/SKILL.md +120 -0
  240. package/app/skills/typescript-patterns/SKILL.md +256 -0
  241. package/app/skills/ubiquitous-language/SKILL.md +74 -0
  242. package/app/skills/verification-before-completion/SKILL.md +108 -0
  243. package/app/skills/workflow/SKILL.md +250 -0
  244. package/app/skills/write-a-prd/SKILL.md +129 -0
  245. package/app/skills/write-a-prd/reference/visual-companion.md +78 -0
  246. package/app/skills/write-a-prd/scripts/frame-template.html +111 -0
  247. package/app/skills/write-a-prd/scripts/visual-server.cjs +79 -0
  248. package/app/templates/skill/generator/SKILL.md.template +40 -0
  249. package/app/templates/skill/knowledge/SKILL.md.template +52 -0
  250. package/app/templates/skill/linter/SKILL.md.template +34 -0
  251. package/app/templates/skill/reviewer/SKILL.md.template +51 -0
  252. package/app/templates/skill/workflow/SKILL.md.template +49 -0
  253. package/benchmarks/README.md +111 -0
  254. package/benchmarks/ecosystem-dashboard.json +148 -0
  255. package/benchmarks/ecosystem-harvest.json +148 -0
  256. package/benchmarks/results.json +38 -0
  257. package/benchmarks/run.py +351 -0
  258. package/bin/ai-toolkit.js +345 -0
  259. package/kb/best-practices/README.md +11 -0
  260. package/kb/howto/README.md +11 -0
  261. package/kb/procedures/maintenance-sop.md +306 -0
  262. package/kb/reference/agents-catalog.md +124 -0
  263. package/kb/reference/anti-pattern-registry-format.md +221 -0
  264. package/kb/reference/architecture-overview.md +232 -0
  265. package/kb/reference/benchmark-config.md +62 -0
  266. package/kb/reference/ci-integration.md +66 -0
  267. package/kb/reference/claude-ecosystem-benchmark-snapshot.md +80 -0
  268. package/kb/reference/claude-ecosystem-expansion-foundations.md +102 -0
  269. package/kb/reference/commands-catalog.md +21 -0
  270. package/kb/reference/distribution-model.md +63 -0
  271. package/kb/reference/global-install-model.md +56 -0
  272. package/kb/reference/hierarchical-override-pattern.md +200 -0
  273. package/kb/reference/hooks-catalog.md +306 -0
  274. package/kb/reference/integrations.md +88 -0
  275. package/kb/reference/language-packs.md +52 -0
  276. package/kb/reference/merge-friendly-install-model.md +58 -0
  277. package/kb/reference/plugin-pack-conventions.md +151 -0
  278. package/kb/reference/quick-wins-implementation-summary.md +70 -0
  279. package/kb/reference/skill-templates.md +50 -0
  280. package/kb/reference/skills-catalog.md +215 -0
  281. package/kb/reference/skills-unification.md +57 -0
  282. package/kb/reference/stats.md +69 -0
  283. package/kb/reference/sync.md +76 -0
  284. package/kb/troubleshooting/README.md +11 -0
  285. package/llms-full.txt +3068 -0
  286. package/llms.txt +39 -0
  287. package/package.json +75 -0
  288. package/scripts/_common.py +160 -0
  289. package/scripts/add_rule.py +50 -0
  290. package/scripts/benchmark_config.py +127 -0
  291. package/scripts/benchmark_ecosystem.py +288 -0
  292. package/scripts/check_deps.py +260 -0
  293. package/scripts/create_skill.py +118 -0
  294. package/scripts/doctor.py +504 -0
  295. package/scripts/eject.py +113 -0
  296. package/scripts/emission.py +256 -0
  297. package/scripts/evaluate_skills.py +260 -0
  298. package/scripts/frontmatter.py +58 -0
  299. package/scripts/generate_agents_md.py +91 -0
  300. package/scripts/generate_aider_conf.py +51 -0
  301. package/scripts/generate_cline.py +35 -0
  302. package/scripts/generate_copilot.py +30 -0
  303. package/scripts/generate_cursor_rules.py +35 -0
  304. package/scripts/generate_gemini.py +28 -0
  305. package/scripts/generate_llms_txt.py +164 -0
  306. package/scripts/generate_roo_modes.py +80 -0
  307. package/scripts/generate_windsurf.py +35 -0
  308. package/scripts/generator_base.py +140 -0
  309. package/scripts/harvest_ecosystem.py +50 -0
  310. package/scripts/inject_rule_cli.py +101 -0
  311. package/scripts/inject_section_cli.py +47 -0
  312. package/scripts/injection.py +180 -0
  313. package/scripts/install.py +236 -0
  314. package/scripts/install_git_hooks.py +71 -0
  315. package/scripts/install_steps/__init__.py +5 -0
  316. package/scripts/install_steps/ai_tools.py +261 -0
  317. package/scripts/install_steps/hooks.py +90 -0
  318. package/scripts/install_steps/markers.py +79 -0
  319. package/scripts/install_steps/symlinks.py +87 -0
  320. package/scripts/merge-hooks.py +192 -0
  321. package/scripts/plugin.py +642 -0
  322. package/scripts/plugin_schema.py +138 -0
  323. package/scripts/remove_rule.py +58 -0
  324. package/scripts/stats.py +81 -0
  325. package/scripts/sync.py +215 -0
  326. package/scripts/uninstall.py +292 -0
  327. package/scripts/validate.py +700 -0
package/README.md ADDED
@@ -0,0 +1,632 @@
1
+ # ai-toolkit
2
+
3
+ > Professional-grade AI coding toolkit with multi-platform support. Machine-enforced safety, 85 skills, 47 agents, expanded lifecycle hooks, experimental opt-in plugin packs, and benchmark tooling — works with Claude, Cursor, Windsurf, Copilot, Gemini, Cline, Roo Code, and Aider, ready in 60 seconds.
4
+
5
+ [![CI](https://github.com/softspark/ai-toolkit/actions/workflows/ci.yml/badge.svg)](https://github.com/softspark/ai-toolkit/actions/workflows/ci.yml)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
7
+ [![Skills](https://img.shields.io/badge/skills-85-brightgreen)](app/skills/)
8
+ [![Agents](https://img.shields.io/badge/agents-47-blue)](app/agents/)
9
+ [![Tests](https://img.shields.io/badge/tests-308%20passing-success)](tests/)
10
+
11
+ ---
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ # Option A: install globally (once per machine)
17
+ npm install -g @softspark/ai-toolkit
18
+ ai-toolkit install
19
+
20
+ # Option B: try without installing (npx)
21
+ npx @softspark/ai-toolkit install
22
+ ```
23
+
24
+ **That's it.** Claude Code picks up 85 skills, 47 agents, quality hooks, and the safety constitution automatically.
25
+
26
+ ### Update
27
+
28
+ ```bash
29
+ npm install -g @softspark/ai-toolkit@latest && ai-toolkit update
30
+ ```
31
+
32
+ ### Per-Project Setup
33
+
34
+ After global install, run `--local` in each project to generate project-specific configs (CLAUDE.md, Copilot, Cline, Roo Code, Aider, git hooks):
35
+
36
+ ```bash
37
+ cd your-project/
38
+ ai-toolkit install --local # first time
39
+ ai-toolkit update --local # after toolkit updates
40
+ ```
41
+
42
+ ### Plugin Management
43
+
44
+ ```bash
45
+ ai-toolkit plugin list # show available packs
46
+ ai-toolkit plugin install --all # install all packs
47
+ ai-toolkit plugin update --all # re-apply after toolkit updates
48
+ ai-toolkit plugin status # show what's installed
49
+ ai-toolkit plugin clean memory-pack --days 30 # prune old data
50
+ ```
51
+
52
+ After each `ai-toolkit update`, also run `ai-toolkit plugin update --all` to keep plugin hooks and scripts in sync.
53
+
54
+ ### Install Profiles
55
+
56
+ ```bash
57
+ ai-toolkit install --profile minimal # agents + skills only (no hooks, no constitution)
58
+ ai-toolkit install --profile standard # full install (default)
59
+ ai-toolkit install --profile strict # full install + git hooks even without --local
60
+ ```
61
+
62
+ ### Selective Install / Update
63
+
64
+ ```bash
65
+ ai-toolkit install --only agents,hooks # first-time: only listed components
66
+ ai-toolkit install --skip hooks # first-time: skip listed components
67
+ ai-toolkit update --only agents,hooks # re-apply: only listed components
68
+ ai-toolkit update --skip cursor # re-apply: skip listed components
69
+ ai-toolkit install --list # dry-run: show what would be applied
70
+ ```
71
+
72
+ ### Verify & Repair
73
+
74
+ ```bash
75
+ ai-toolkit validate # check toolkit integrity
76
+ ai-toolkit validate --strict # CI-grade: warnings = errors
77
+ ai-toolkit doctor # diagnose install health, hooks, and artifact drift
78
+ ai-toolkit doctor --fix # auto-repair: broken symlinks, missing hooks, stale artifacts
79
+ ```
80
+
81
+ ### Eject (standalone, no toolkit dependency)
82
+
83
+ ```bash
84
+ ai-toolkit eject # export to current directory
85
+ ai-toolkit eject /path/to # export to custom directory
86
+ ```
87
+
88
+ Replaces all symlinks with real files, inlines rules into CLAUDE.md, copies constitution and architecture. After eject you can `npm uninstall -g @softspark/ai-toolkit`.
89
+
90
+ ---
91
+
92
+ ## Platform Support
93
+
94
+ | Platform | Config File | How | Scope |
95
+ |----------|------------|-----|-------|
96
+ | Claude Code | `~/.claude/` | `ai-toolkit install` | global |
97
+ | Cursor | `~/.cursor/rules` | `ai-toolkit install` | global |
98
+ | Windsurf | `~/.codeium/windsurf/memories/global_rules.md` | `ai-toolkit install` | global |
99
+ | Gemini CLI | `~/.gemini/GEMINI.md` | `ai-toolkit install` | global |
100
+ | GitHub Copilot | `.github/copilot-instructions.md` | `ai-toolkit install --local` | project |
101
+ | Cline | `.clinerules` | `ai-toolkit install --local` | project |
102
+ | Roo Code | `.roomodes` | `ai-toolkit install --local` | project |
103
+ | Aider | `.aider.conf.yml` | `ai-toolkit install --local` | project |
104
+ | Codex / OpenCode | `AGENTS.md` | `ai-toolkit agents-md` | project |
105
+
106
+ > **Note:** Claude Code remains the primary platform with full feature support (agents, lifecycle hooks, safety constitution). Other platforms receive a distilled ruleset generated from the same source. For editors lacking native bash lifecycle hooks, `--local` installs a Git hooks fallback (`.git/hooks/pre-commit`) to enforce quality gates pre-commit.
107
+
108
+ ---
109
+
110
+ ## What You Get
111
+
112
+ | Component | Count | Description |
113
+ |-----------|-------|-------------|
114
+ | `skills/` (task) | 27 | Slash commands: `/commit`, `/build`, `/deploy`, `/test`, ... |
115
+ | `skills/` (hybrid) | 27 | Slash commands with agent knowledge base |
116
+ | `skills/` (knowledge) | 31 | Domain knowledge auto-loaded by agents |
117
+ | `agents/` | 47 | Specialized agents across 10 categories |
118
+ | `hooks/` | 15 global + 5 skill-scoped | Quality gates, path safety, CLAUDE.md enforcement, notifications, prompt governance, subagent lifecycle, session-end handoff, usage tracking |
119
+ | `plugins/` | 11 experimental opt-in packs | Domain bundles for security, research, frontend, enterprise, and 6 language packs (not part of the default install) |
120
+ | `output-styles/` | 1 style | System prompt output style overrides (e.g. Golden Rules) |
121
+ | `constitution.md` | 5 articles | Machine-enforced safety rules |
122
+ | `rules/` | auto-injected | Rules injected into your CLAUDE.md on `install` / `update` |
123
+ | `kb/` | reference docs | Architecture, operating models, procedures, and best practices |
124
+
125
+ ---
126
+
127
+ ## Architecture
128
+
129
+ ```
130
+ ai-toolkit/
131
+ ├── app/
132
+ │ ├── agents/ # 47 agent definitions
133
+ │ │ ├── orchestrator.md
134
+ │ │ ├── backend-specialist.md
135
+ │ │ ├── security-architect.md
136
+ │ │ └── ... (44 more)
137
+ │ ├── skills/ # 85 skills (task / hybrid / knowledge)
138
+ │ │ ├── commit/ # /commit slash command
139
+ │ │ ├── review/ # /review slash command
140
+ │ │ ├── clean-code/ # knowledge skill (auto-loaded)
141
+ │ │ └── ... (82 more)
142
+ │ ├── rules/ # Auto-injected into your CLAUDE.md
143
+ │ ├── hooks/ # Hook scripts (copied to ~/.ai-toolkit/hooks/)
144
+ │ │ ├── session-start.sh # MANDATORY reminder + session context
145
+ │ │ ├── guard-destructive.sh # Block rm -rf, DROP TABLE, etc.
146
+ │ │ ├── guard-path.sh # Block wrong-user path hallucination
147
+ │ │ ├── user-prompt-submit.sh # Prompt governance reminder
148
+ │ │ ├── quality-check.sh # Multi-language lint on stop
149
+ │ │ ├── quality-gate.sh # Block task completion on errors
150
+ │ │ ├── save-session.sh # Persist session context
151
+ │ │ ├── subagent-start.sh # Subagent scope reminder
152
+ │ │ ├── subagent-stop.sh # Subagent completion checklist
153
+ │ │ ├── pre-compact.sh # Save context before compaction
154
+ │ │ ├── session-end.sh # Session handoff snapshot
155
+ │ │ └── post-tool-use.sh # Lightweight feedback after edits
156
+ │ ├── hooks.json # Hook definitions (merged into settings.json)
157
+ │ ├── plugins/ # Experimental plugin packs (opt-in, not part of default install)
158
+ │ ├── output-styles/ # System prompt output style overrides
159
+ │ ├── constitution.md # 5 immutable safety articles
160
+ │ └── ARCHITECTURE.md # Full system design
161
+ ├── kb/ # Reference docs, architecture notes, procedures
162
+ ├── scripts/ # Validation, install, evaluation scripts
163
+ ├── tests/ # Bats test suite
164
+ └── CHANGELOG.md
165
+ ```
166
+
167
+ **Distribution model:** Symlink-based for agents/skills, copy-based for hooks. `~/.claude/agents/` and `~/.claude/skills/` contain per-file symlinks into the npm package. Hook scripts are copied to `~/.ai-toolkit/hooks/` and referenced from `~/.claude/settings.json`. Run `ai-toolkit update` after `npm install` — all projects pick up changes instantly. (See [Distribution Model](kb/reference/distribution-model.md))
168
+
169
+ ---
170
+
171
+ ## Key Slash Commands
172
+
173
+ | Command | Purpose | Effort |
174
+ |---------|---------|--------|
175
+ | `/workflow <type>` | Pre-defined multi-agent workflow (15 types — see below) | max |
176
+ | `/orchestrate` | Custom multi-agent coordination (3–6 agents, you define domains) | max |
177
+ | `/swarm` | Parallel Agent Teams: `map-reduce`, `consensus`, or `relay` | max |
178
+ | `/plan` | Implementation plan with task breakdown | high |
179
+ | `/review` | Code review: quality, security, performance | high |
180
+ | `/debug` | Systematic debugging with diagnostics | medium |
181
+ | `/refactor` | Safe refactoring with pattern analysis | high |
182
+ | `/explore` | Interactive codebase visualization and discovery | medium |
183
+ | `/test` | Run tests (Python, JS/TS, PHP, Flutter, Go, Rust) | medium |
184
+ | `/deploy` | Deploy with pre-flight checks | medium |
185
+ | `/rollback` | Rollback deployment with state verification | medium |
186
+ | `/ci` | Generate CI/CD pipeline configuration | medium |
187
+ | `/migrate` | Database migration workflow | medium |
188
+ | `/commit` | Structured commit with linting | medium |
189
+ | `/pr` | Pull request with generated checklist | medium |
190
+ | `/docs` | Generate README, API docs, architecture notes, changelogs | high |
191
+ | `/hook-creator` | Scaffold a new Claude Code hook with validation conventions | high |
192
+ | `/command-creator` | Scaffold a new slash command with frontmatter and workflow guidance | high |
193
+ | `/agent-creator` | Scaffold a new specialized agent with tools and trigger guidance | high |
194
+ | `/plugin-creator` | Scaffold an experimental plugin pack with manifest and optional modules | high |
195
+ | `/analyze` | Code quality, complexity, and pattern analysis | medium |
196
+ | `/fix` | Auto-fix lint/type errors | low |
197
+ | `/build` | Build with issue detection | low |
198
+ | `/lint` | Run linters and report issues | low |
199
+ | `/health` | Service health report | medium |
200
+ | `/panic` | Emergency halt all autonomous operations | low |
201
+ | `/write-a-prd` | Create PRD through interactive interview and module design | high |
202
+ | `/prd-to-plan` | Convert PRD into phased vertical-slice implementation plan | high |
203
+ | `/prd-to-issues` | Break PRD into GitHub issues with HITL/AFK tagging | medium |
204
+ | `/tdd` | Test-driven development with red-green-refactor loop | high |
205
+ | `/design-an-interface` | Generate 3+ radically different interface designs (parallel agents) | high |
206
+ | `/grill-me` | Stress-test a plan through relentless Socratic questioning | medium |
207
+ | `/ubiquitous-language` | Extract DDD-style glossary from conversation | medium |
208
+ | `/refactor-plan` | Plan refactor with tiny commits via interview | high |
209
+ | `/qa-session` | Interactive QA — report bugs, file GitHub issues | high |
210
+ | `/triage-issue` | Triage bug with deep investigation and TDD fix plan | high |
211
+ | `/architecture-audit` | Discover shallow modules, propose deepening refactors | high |
212
+ | `/subagent-development` | Execute plans with 2-stage review (spec + quality) per task | high |
213
+ | `/repeat` | Autonomous loop with safety controls (Ralph Wiggum pattern) | medium |
214
+ | `/mem-search` | Search past coding sessions via natural language (memory-pack) | medium |
215
+
216
+ ### `/workflow` Types
217
+
218
+ ```bash
219
+ /workflow feature-development # New feature, full stack
220
+ /workflow backend-feature # API + logic + tests
221
+ /workflow frontend-feature # UI component + state + tests
222
+ /workflow api-design # Design → implement → document
223
+ /workflow database-evolution # Schema change + migration + code
224
+ /workflow test-coverage # Boost coverage for a module
225
+ /workflow security-audit # Multi-vector security assessment
226
+ /workflow codebase-onboarding # Understand unfamiliar codebase
227
+ /workflow spike # Time-boxed research → architecture note
228
+ /workflow debugging # Bug spanning multiple layers
229
+ /workflow incident-response # Production down
230
+ /workflow performance-optimization # Degradation >50%
231
+ /workflow infrastructure-change # Docker, CI/CD, infra
232
+ /workflow application-deploy # Full deploy workflow
233
+ /workflow proactive-troubleshooting # Warning / trend analysis
234
+ ```
235
+
236
+ ---
237
+
238
+ ## Unique Differentiators
239
+
240
+ ### 1. Machine-Enforced Constitution
241
+
242
+ Unlike other toolkits that put safety rules in documentation only, ai-toolkit enforces a 5-article constitution via `PreToolUse` hooks. The hook actually **blocks** execution of:
243
+ - Mass deletion (`rm -rf`, `DROP TABLE`)
244
+ - Blind overwrites of uncommitted work
245
+ - Any action that could cause irreversible data loss
246
+
247
+ ### 2. Hooks as Executable Scripts
248
+
249
+ Hook logic lives in `app/hooks/*.sh` — not inline JSON one-liners. Scripts are copied to `~/.ai-toolkit/hooks/` on install and referenced from `~/.claude/settings.json`. Easy to read, debug, and extend.
250
+
251
+ **12 lifecycle events / 15 global hook entries:**
252
+
253
+ | Event | Script | Action |
254
+ |-------|--------|--------|
255
+ | SessionStart | `session-start.sh` | MANDATORY rules reminder + session context + instincts |
256
+ | Notification | *(inline)* | macOS desktop notification |
257
+ | PreToolUse | `guard-destructive.sh` | Block `rm -rf`, `DROP TABLE`, etc. |
258
+ | PreToolUse | `guard-path.sh` | Block wrong-user path hallucination |
259
+ | UserPromptSubmit | `user-prompt-submit.sh` | Prompt governance reminder for planning, research, and safe execution |
260
+ | UserPromptSubmit | `track-usage.sh` | Record skill invocations to local stats |
261
+ | PostToolUse | `post-tool-use.sh` | Lightweight validation reminders after edits |
262
+ | Stop | `quality-check.sh` | Multi-language lint (ruff/tsc/phpstan/dart/go) |
263
+ | Stop | `save-session.sh` | Persist session context for cross-session continuity |
264
+ | TaskCompleted | `quality-gate.sh` | Block task completion on lint/type errors |
265
+ | SubagentStart | `subagent-start.sh` | Narrow-scope reminder for spawned subagents |
266
+ | SubagentStop | `subagent-stop.sh` | Completion checklist for subagent handoff |
267
+ | PreCompact | `pre-compact.sh` | Preserve context and instincts before compaction |
268
+ | SessionEnd | `session-end.sh` | Persist a session-end handoff note |
269
+ | TeammateIdle | *(inline)* | Completeness reminder |
270
+
271
+ **5 skill-scoped hooks:**
272
+
273
+ | Skill | Hook | Action |
274
+ |-------|------|--------|
275
+ | `/commit` | Pre | Run linter, block on failure |
276
+ | `/test` | Post | Coverage check, report threshold |
277
+ | `/deploy` | Post | Health check, rollback if degraded |
278
+ | `/migrate` | Pre | Backup verification |
279
+ | `/rollback` | Post | State verification |
280
+
281
+ ### 3. Effort-Based Model Budgeting
282
+
283
+ Every skill declares an effort level used for model token budgeting:
284
+ - `low` — lint, build, fix (fast, cheap)
285
+ - `medium` — debug, analyze, ci
286
+ - `high` — review, plan, refactor, docs
287
+ - `max` — orchestrate, swarm, workflow
288
+
289
+ ### 4. Multi-Language Quality Gates
290
+
291
+ The `Stop` hook runs after every response across 5 languages:
292
+
293
+ | Language | Lint | Type Check |
294
+ |----------|------|-----------|
295
+ | Python | ruff | mypy --strict |
296
+ | TypeScript | ESLint/tsc | tsc --noEmit |
297
+ | PHP | phpstan | phpstan |
298
+ | Dart | dart analyze | dart analyze |
299
+ | Go | go vet | go vet |
300
+
301
+ ### 5. Iron Law Enforcement
302
+
303
+ Three skills enforce non-negotiable quality gates with anti-rationalization tables:
304
+
305
+ | Skill | Iron Law | What it prevents |
306
+ |-------|----------|-----------------|
307
+ | `/tdd` | `NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST` | Code written before test? Delete it. Start over. No exceptions. |
308
+ | `debugging-tactics` | `NO FIXES WITHOUT ROOT CAUSE INVESTIGATION FIRST` | 4-phase debugging: root cause → pattern → hypothesis → fix. 3+ failed fixes → question architecture. |
309
+ | `verification-before-completion` | `NO COMPLETION CLAIMS WITHOUT FRESH VERIFICATION EVIDENCE` | Gate function: IDENTIFY → RUN → READ → VERIFY → CLAIM. "Should work now" is not evidence. |
310
+
311
+ ### 6. Two-Stage Review (`/subagent-development`)
312
+
313
+ Per-task review pipeline inspired by [obra/superpowers](https://github.com/obra/superpowers):
314
+
315
+ ```
316
+ Implementer → Spec Compliance Review → Code Quality Review → Next Task
317
+ ```
318
+
319
+ - Implementer reports status: `DONE` / `DONE_WITH_CONCERNS` / `NEEDS_CONTEXT` / `BLOCKED`
320
+ - Spec reviewer verifies: all requirements met, nothing extra, nothing missing
321
+ - Quality reviewer checks: SOLID, naming, error handling, tests, security
322
+ - Prompt templates included: `reference/implementer-prompt.md`, `spec-reviewer-prompt.md`, `code-quality-reviewer-prompt.md`
323
+
324
+ ### 7. Ralph Wiggum Loop (`/repeat`)
325
+
326
+ Autonomous agent loop with safety controls:
327
+
328
+ ```bash
329
+ /repeat 5m /test # run tests every 5 min until all pass
330
+ /repeat --iterations 3 /review # max 3 review passes
331
+ ```
332
+
333
+ | Safety Control | Default |
334
+ |----------------|---------|
335
+ | Max iterations | 5 |
336
+ | Circuit breaker | 3 consecutive failures → halt |
337
+ | Min interval | 1 minute |
338
+ | Exit detection | DONE / COMPLETE / ALL PASS |
339
+ | Stats logging | Every iteration to `stats.json` |
340
+
341
+ Constitution Article I, Section 4 enforces these limits.
342
+
343
+ ### 8. Visual Brainstorming Companion
344
+
345
+ Optional browser-based companion for `/write-a-prd` and `/design-an-interface`:
346
+
347
+ - Ephemeral Node.js HTTP server (auto-kills after 30min idle)
348
+ - Dark theme, responsive, zero external dependencies
349
+ - Per-question routing: mockups/diagrams → browser, text/conceptual → terminal
350
+ - Consent-based: offered once as its own message, never forced
351
+
352
+ ### 9. Persistent Memory (`memory-pack` plugin)
353
+
354
+ SQLite-based session memory (opt-in plugin pack):
355
+
356
+ | Component | Purpose |
357
+ |-----------|---------|
358
+ | `observation-capture.sh` | PostToolUse hook — captures tool actions to SQLite |
359
+ | `session-summary.sh` | Stop hook — AI-compress session observations |
360
+ | `mem-search` skill | FTS5 full-text search across past sessions |
361
+ | `<private>` tags | Content between tags stripped before storage |
362
+ | Progressive disclosure | Summary (~500 tok) → relevant (~2k tok) → full |
363
+
364
+
365
+
366
+ ### 11. KB Integration Protocol
367
+
368
+ Agents follow a research-before-action protocol enforced via rules:
369
+ 1. `smart_query()` or `hybrid_search_kb()` before any technical answer
370
+ 2. Source citation mandatory (`[PATH: kb/...]`)
371
+ 3. Strict order: KB → Files → External Docs → General Knowledge
372
+
373
+ ---
374
+
375
+ ## Plugin Packs (Opt-in)
376
+
377
+ 11 experimental plugin packs — domain bundles not part of the default install. Each pack bundles agents, skills, hooks, and/or rules for a specific domain.
378
+
379
+ | Pack | Domain | Agents | Skills | Hooks | Description |
380
+ |------|--------|--------|--------|-------|-------------|
381
+ | `security-pack` | security | 3 | 3 | 2 | Security auditing, threat modeling, OWASP checks |
382
+ | `research-pack` | research | 4 | 4 | 1 | Multi-source research, synthesis, fact-checking |
383
+ | `frontend-pack` | frontend | 3 | 3 | 1 | React/Vue/CSS craft, SEO, design engineering |
384
+ | `enterprise-pack` | enterprise | 3 | 3 | 3 | Executive briefings, infra architecture, status reporting |
385
+ | `memory-pack` | memory | 0 | 1 | 2 | SQLite-based persistent memory with FTS5 search across sessions |
386
+ | `rust-pack` | rust | 0 | 1 | 0 | Rust ownership, borrowing, Cargo, tokio, serde patterns |
387
+ | `java-pack` | java | 0 | 1 | 0 | Records, sealed classes, Spring Boot, JUnit 5 |
388
+ | `csharp-pack` | csharp | 0 | 1 | 0 | Nullable refs, async/await, ASP.NET Core, EF Core |
389
+ | `kotlin-pack` | kotlin | 0 | 1 | 0 | Coroutines, DSLs, sealed classes, Ktor, MockK |
390
+ | `swift-pack` | swift | 0 | 1 | 0 | Protocol-oriented, SwiftUI, async/await, SPM |
391
+ | `ruby-pack` | ruby | 0 | 1 | 0 | Blocks, Rails conventions, RSpec, ActiveRecord |
392
+
393
+ All packs have `status: experimental`. Each has a `plugin.json` manifest and `README.md` with installation instructions.
394
+
395
+ ---
396
+
397
+ ## Comparison
398
+
399
+ | Feature | ai-toolkit | everything-claude-code | wshobson/agents | ruflo |
400
+ |---------|---------------|----------------------|-----------------|-------|
401
+ | Skills | 85 | 100+ | 146 | 20+ |
402
+ | Agents | 47 | 30+ | 112 | 20+ |
403
+ | Machine-enforced constitution | **Yes** | No (docs only) | No | No |
404
+ | Skill-scoped lifecycle hooks | **Yes** | No | No | No |
405
+ | Effort-based model budgeting | **Yes** | No | No | No |
406
+ | Test suite | Yes (bats) | Yes (997 tests) | No | Yes |
407
+ | npm/npx install | Yes | Yes | Yes | Yes |
408
+ | Cross-tool support | **Cursor, Windsurf, Copilot, Gemini, Cline, Roo, Aider, Codex** | 5+ tools | Smithery | Limited |
409
+ | Selective install | Yes | Yes | Yes (72 plugins) | No |
410
+ | Session persistence | Yes | Yes | No | No |
411
+ | Architecture notes | **Yes** | No | No | No |
412
+ | KB/RAG integration | **Yes** | No | No | Yes |
413
+ | License | MIT | MIT | MIT | MIT |
414
+
415
+ ---
416
+
417
+ ## Agent Teams
418
+
419
+ Native support for `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1`:
420
+
421
+ ```bash
422
+ export CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1
423
+ ```
424
+
425
+ Pre-configured team presets via `/teams`:
426
+
427
+ | Preset | Agents | Use Case |
428
+ |--------|--------|----------|
429
+ | `review` | code-reviewer, security-auditor, performance-optimizer | PR review |
430
+ | `debug` | debugger, backend-specialist, incident-responder | Multi-file bug |
431
+ | `feature` | orchestrator, backend-specialist, frontend-specialist, test-engineer | Full feature |
432
+ | `fullstack` | backend-specialist, frontend-specialist, database-architect, devops-implementer | Stack feature |
433
+ | `research` | technical-researcher, data-analyst, prompt-engineer | Deep research |
434
+ | `security` | security-architect, security-auditor, backend-specialist | Security audit |
435
+ | `migration` | database-architect, backend-specialist, devops-implementer | DB migration |
436
+
437
+ ---
438
+
439
+ ## Cross-Tool Support
440
+
441
+ | Tool | Config | Scope |
442
+ |------|--------|-------|
443
+ | Claude Code | `~/.claude/settings.json` (hooks), `~/.claude/` (agents, skills, constitution) | global |
444
+ | Cursor | `~/.cursor/rules` | global |
445
+ | Windsurf | `~/.codeium/windsurf/memories/global_rules.md` | global |
446
+ | Gemini CLI | `~/.gemini/GEMINI.md` | global |
447
+ | GitHub Copilot | `.github/copilot-instructions.md` | project |
448
+ | Cline | `.clinerules` | project |
449
+ | Roo Code | `.roomodes` | project |
450
+ | Aider | `.aider.conf.yml` | project |
451
+ | Codex / OpenCode | `AGENTS.md` | project |
452
+
453
+ ```bash
454
+ # First-time install (Claude + Cursor + Windsurf + Gemini)
455
+ ai-toolkit install
456
+
457
+ # After npm update — re-apply updated components
458
+ ai-toolkit update
459
+
460
+ # Init project (CLAUDE.md + settings + constitution + Copilot + Cline + Roo + Aider + Git Hooks + MCP Default)
461
+ ai-toolkit install --local
462
+
463
+ # Update project-local configs after toolkit update
464
+ ai-toolkit update --local
465
+ ```
466
+
467
+ > `install --local` prepares project files only. Hooks stay global and remain merged into `~/.claude/settings.json`. Git hooks are added as a safety fallback for editors without native hooks.
468
+
469
+ ---
470
+
471
+ ## Session Persistence
472
+
473
+ Context survives across Claude Code sessions:
474
+
475
+ ```bash
476
+ # Enabled by default after install
477
+ # Saved to: .claude/session-context.md
478
+ # Loaded on: SessionStart hook
479
+ ```
480
+
481
+ ---
482
+
483
+ ## Hook Runtime Profiles
484
+
485
+ ```bash
486
+ # In .claude/settings.local.json
487
+ {
488
+ "env": {
489
+ "TOOLKIT_HOOK_PROFILE": "minimal" # minimal | standard | strict
490
+ }
491
+ }
492
+ ```
493
+
494
+ | Profile | Description |
495
+ |---------|-------------|
496
+ | `minimal` | Destructive command guard only |
497
+ | `standard` | All hooks (default) |
498
+ | `strict` | Standard + coverage enforcement + strict type checks |
499
+
500
+ ---
501
+
502
+ ## Post-Install Setup
503
+
504
+ 1. **Customize CLAUDE.md** — add your project's tech stack, commands, and conventions at the top (above the toolkit markers).
505
+
506
+ 2. **Configure settings**:
507
+ ```bash
508
+ # .claude/settings.local.json
509
+ {
510
+ "mcpServers": { ... },
511
+ "env": { "TOOLKIT_HOOK_PROFILE": "standard" }
512
+ }
513
+ ```
514
+
515
+ 3. **Verify**:
516
+ ```bash
517
+ ai-toolkit validate
518
+ ```
519
+
520
+ 4. **Start**:
521
+ ```
522
+ /onboard # guided setup
523
+ /explore # understand your codebase
524
+ /plan # plan a feature
525
+ ```
526
+
527
+ ---
528
+
529
+ ## CLI Reference
530
+
531
+ ```
532
+ Usage: ai-toolkit <command> [options]
533
+ ```
534
+
535
+ | Command | Description |
536
+ |---------|-------------|
537
+ | `install` | First-time global install into `~/.claude/` + Cursor, Windsurf, Gemini |
538
+ | `install --local` | Also set up project-local configs (CLAUDE.md, settings, constitution, Copilot, Cline, Roo, Aider, Git Hooks, MCP Defaults) |
539
+ | `update` | Re-apply toolkit after `npm install -g @softspark/ai-toolkit@latest` |
540
+ | `update --local` | Re-apply + refresh project-local configs in current dir |
541
+ | `reset --local` | Wipe all project-local configs and recreate from scratch (clean slate) |
542
+ | `add-rule <rule.md> [name]` | Register rule in `~/.ai-toolkit/rules/` — auto-applied on every `update` |
543
+ | `remove-rule <name> [dir]` | Unregister rule from `~/.ai-toolkit/rules/` and remove its block from `CLAUDE.md` |
544
+ | `validate` | Verify toolkit integrity (`--strict` for CI-grade, warnings = errors) |
545
+ | `doctor` | Diagnose install health, hooks, quick-win assets, and artifact drift |
546
+ | `doctor --fix` | Auto-repair broken symlinks, missing hooks, stale artifacts |
547
+ | `eject [dir]` | Export standalone config (no symlinks, no toolkit dependency) |
548
+ | `plugin list` | Show available plugin packs with install status |
549
+ | `plugin install <name>` | Install a plugin pack (hooks, scripts, verify agents/skills) |
550
+ | `plugin install --all` | Install all 11 plugin packs |
551
+ | `plugin update <name>` | Update a plugin pack (remove + reinstall, preserves data) |
552
+ | `plugin update --all` | Update all installed plugin packs |
553
+ | `plugin clean <name> [--days N]` | Prune old plugin data (default: 90 days) |
554
+ | `plugin remove <name>` | Remove a plugin pack |
555
+ | `plugin status` | Show installed plugins with data stats (DB size, observation count) |
556
+ | `stats` | Show skill usage statistics (`--reset` to clear, `--json` for raw output) |
557
+ | `benchmark --my-config` | Compare your installed config vs toolkit defaults vs ecosystem |
558
+ | `benchmark-ecosystem` | Generate a benchmark snapshot for official Claude Code and external ecosystem repos |
559
+ | `create skill <name>` | Scaffold new skill from template (`--template=linter\|reviewer\|generator\|workflow\|knowledge`) |
560
+ | `sync` | Config portability via GitHub Gist (`--export`, `--push`, `--pull`, `--import`) |
561
+ | `evaluate` | Run skill evaluation suite |
562
+ | `uninstall` | Remove toolkit from `~/.claude/` |
563
+ | `cursor-rules` | Generate `.cursorrules` in current dir |
564
+ | `windsurf-rules` | Generate `.windsurfrules` in current dir |
565
+ | `copilot-instructions` | Generate `.github/copilot-instructions.md` in current dir |
566
+ | `gemini-md` | Generate `GEMINI.md` in current dir |
567
+ | `cline-rules` | Generate `.clinerules` in current dir |
568
+ | `roo-modes` | Generate `.roomodes` in current dir |
569
+ | `aider-conf` | Generate `.aider.conf.yml` in current dir |
570
+ | `agents-md` | Regenerate `AGENTS.md` from agent definitions |
571
+ | `llms-txt` | Generate `llms.txt` and `llms-full.txt` |
572
+ | `generate-all` | Generate all platform configs at once |
573
+ | `help` | Show help |
574
+
575
+ **Options for `install` and `update`:**
576
+
577
+ ```bash
578
+ ai-toolkit install --only agents,hooks # apply only listed components
579
+ ai-toolkit install --skip hooks # skip listed components
580
+ ai-toolkit install --profile minimal # profile preset: minimal | standard | strict
581
+ ai-toolkit install --local # also set up project-local configs (CLAUDE.md, settings, constitution, Copilot, Cline, Roo, Aider, Git Hooks, MCP Defaults)
582
+ ai-toolkit update --local # re-apply + refresh project-local configs
583
+ ai-toolkit install --list # dry-run: show what would be applied
584
+ ```
585
+
586
+ ---
587
+
588
+ ## Injecting Rules from Another Repo
589
+
590
+ Any repo can register its rules so they are automatically injected into all AI tool configs on every `update`:
591
+
592
+ ```bash
593
+ cd /path/to/your-repo
594
+ ai-toolkit add-rule ./jira-rules.md
595
+ # Registered: 'jira-rules' → ~/.ai-toolkit/rules/jira-rules.md
596
+
597
+ ai-toolkit update
598
+ # → injects jira-rules into ~/.claude/CLAUDE.md, ~/.cursor/rules, Windsurf, Gemini
599
+ ```
600
+
601
+ Rules are stored in `~/.ai-toolkit/rules/` and re-applied on every `update`. Injection is **idempotent** — re-running updates only the marked block, never touching content outside it.
602
+
603
+ To unregister:
604
+
605
+ ```bash
606
+ ai-toolkit remove-rule jira-rules
607
+ # Removes from ~/.ai-toolkit/rules/ and strips the block from ~/.claude/CLAUDE.md
608
+ ```
609
+
610
+ See [`kb/reference/integrations.md`](kb/reference/integrations.md) for known integrations.
611
+
612
+ ---
613
+
614
+ ## Contributing
615
+
616
+ See [CONTRIBUTING.md](.github/CONTRIBUTING.md).
617
+
618
+ ## Security
619
+
620
+ See [SECURITY.md](SECURITY.md) for responsible disclosure policy.
621
+
622
+ ## License
623
+
624
+ MIT -- see [LICENSE](LICENSE).
625
+
626
+ ## Changelog
627
+
628
+ See [CHANGELOG.md](CHANGELOG.md).
629
+
630
+ ---
631
+
632
+ *Extracted from production use at SoftSpark. Built to be the toolkit we wished existed.*
package/action.yml ADDED
@@ -0,0 +1,53 @@
1
+ name: 'AI Toolkit Validate'
2
+ description: 'Validate ai-toolkit integrity in CI pipelines'
3
+ author: 'SoftSpark'
4
+ branding:
5
+ icon: 'check-circle'
6
+ color: 'green'
7
+
8
+ inputs:
9
+ toolkit-version:
10
+ description: 'Version of @softspark/ai-toolkit to use'
11
+ required: false
12
+ default: 'latest'
13
+ node-version:
14
+ description: 'Node.js version'
15
+ required: false
16
+ default: '20'
17
+ command:
18
+ description: 'ai-toolkit command to run (validate or doctor)'
19
+ required: false
20
+ default: 'validate'
21
+
22
+ outputs:
23
+ status:
24
+ description: 'pass or fail'
25
+ value: ${{ steps.run-toolkit.outputs.status }}
26
+
27
+ runs:
28
+ using: 'composite'
29
+ steps:
30
+ - name: Setup Node.js
31
+ uses: actions/setup-node@v4
32
+ with:
33
+ node-version: ${{ inputs.node-version }}
34
+
35
+ - name: Install ai-toolkit
36
+ shell: bash
37
+ run: npm install -g @softspark/ai-toolkit@${{ inputs.toolkit-version }}
38
+
39
+ - name: Run ai-toolkit
40
+ id: run-toolkit
41
+ shell: bash
42
+ run: |
43
+ COMMAND="${{ inputs.command }}"
44
+ case "$COMMAND" in
45
+ validate|doctor) ;;
46
+ *) echo "Error: invalid command '$COMMAND' (allowed: validate, doctor)"; exit 1 ;;
47
+ esac
48
+ if ai-toolkit "$COMMAND"; then
49
+ echo "status=pass" >> "$GITHUB_OUTPUT"
50
+ else
51
+ echo "status=fail" >> "$GITHUB_OUTPUT"
52
+ exit 1
53
+ fi