@softspark/ai-toolkit 2.0.2 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/CHANGELOG.md +49 -0
  2. package/README.md +143 -774
  3. package/app/ARCHITECTURE.md +1 -1
  4. package/app/plugins/README.md +6 -2
  5. package/app/skills/plugin-creator/SKILL.md +3 -4
  6. package/bin/ai-toolkit.js +34 -10
  7. package/kb/procedures/maintenance-sop.md +64 -16
  8. package/kb/procedures/release-preparation-sop.md +4 -2
  9. package/kb/procedures/release-verification-sop.md +15 -13
  10. package/kb/reference/architecture-overview.md +44 -5
  11. package/kb/reference/claude-ecosystem-expansion-foundations.md +4 -4
  12. package/kb/reference/cli-reference.md +135 -0
  13. package/kb/reference/codex-cli-compatibility.md +136 -0
  14. package/kb/reference/comparison.md +29 -0
  15. package/kb/reference/extension-api.md +23 -6
  16. package/kb/reference/global-install-model.md +62 -5
  17. package/kb/reference/mcp-editor-compatibility.md +62 -0
  18. package/kb/reference/mcp-templates.md +32 -6
  19. package/kb/reference/plugin-pack-conventions.md +22 -21
  20. package/kb/reference/skills-catalog.md +27 -5
  21. package/kb/reference/unique-features.md +213 -0
  22. package/llms-full.txt +903 -84
  23. package/llms.txt +5 -0
  24. package/package.json +6 -5
  25. package/scripts/codex_skill_adapter.py +295 -0
  26. package/scripts/dir_rules_shared.py +46 -7
  27. package/scripts/generate_agents_md.py +13 -0
  28. package/scripts/generate_antigravity.py +2 -1
  29. package/scripts/generate_augment_rules.py +2 -1
  30. package/scripts/generate_cline_rules.py +13 -3
  31. package/scripts/generate_codex.py +105 -0
  32. package/scripts/generate_codex_hooks.py +78 -0
  33. package/scripts/generate_codex_rules.py +52 -0
  34. package/scripts/generate_cursor_mdc.py +2 -1
  35. package/scripts/generate_roo_rules.py +2 -1
  36. package/scripts/generate_windsurf_rules.py +2 -1
  37. package/scripts/generator_base.py +15 -0
  38. package/scripts/install_steps/ai_tools.py +83 -4
  39. package/scripts/mcp_editors.py +340 -0
  40. package/scripts/mcp_manager.py +125 -13
  41. package/scripts/plugin.py +745 -301
  42. package/scripts/plugin_schema.py +16 -1
package/README.md CHANGED
@@ -1,12 +1,37 @@
1
1
  # ai-toolkit
2
2
 
3
- > Professional-grade AI coding toolkit with multi-platform support. Machine-enforced safety, 92 skills, 44 agents, expanded lifecycle hooks, persona presets, experimental opt-in plugin packs, and benchmark tooling — works with Claude, Cursor, Windsurf, Copilot, Gemini, Cline, Roo Code, Aider, Augment, and Google Antigravity, ready in 60 seconds.
3
+ > Professional-grade AI coding toolkit with multi-platform support. Machine-enforced safety, 92 skills, 44 agents, expanded lifecycle hooks, persona presets, experimental opt-in plugin packs, and benchmark tooling — works with Claude, Cursor, Windsurf, Copilot, Gemini, Cline, Roo Code, Aider, Augment, Google Antigravity, and Codex CLI, ready in 60 seconds.
4
4
 
5
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
6
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
7
7
  [![Skills](https://img.shields.io/badge/skills-92-brightgreen)](app/skills/)
8
8
  [![Agents](https://img.shields.io/badge/agents-44-blue)](app/agents/)
9
- [![Tests](https://img.shields.io/badge/tests-575%20passing-success)](tests/)
9
+ [![Tests](https://img.shields.io/badge/tests-598%20passing-success)](tests/)
10
+
11
+ ---
12
+
13
+ ## What's New in v2.1.1
14
+
15
+ - **Custom rules in generators** — `generate:all` now preserves registered rules from other repos across all platforms
16
+ - **README restructured** — 951 → 292 lines with TOC, "What's New" section, and links to KB docs
17
+ - **CLI help completeness** — added missing `--persona` option and `codex` to `--editors`
18
+ - **3 new KB docs** — CLI Reference, Unique Features, Ecosystem Comparison (moved from README)
19
+
20
+ See [CHANGELOG.md](CHANGELOG.md) for full history.
21
+
22
+ ---
23
+
24
+ ## Table of Contents
25
+
26
+ - [Install](#install)
27
+ - [Platform Support](#platform-support)
28
+ - [What You Get](#what-you-get)
29
+ - [Architecture](#architecture)
30
+ - [Key Features](#key-features)
31
+ - [Key Slash Commands](#key-slash-commands)
32
+ - [Getting Started](#getting-started)
33
+ - [Documentation](#documentation)
34
+ - [Contributing](#contributing)
10
35
 
11
36
  ---
12
37
 
@@ -31,117 +56,58 @@ npm install -g @softspark/ai-toolkit@latest && ai-toolkit update
31
56
 
32
57
  ### Per-Project Setup
33
58
 
34
- After global install, run `--local` in each project. By default, only Claude Code configs are installed (CLAUDE.md, settings, constitution, language rules). Add `--editors` for other tools:
35
-
36
59
  ```bash
37
60
  cd your-project/
38
- ai-toolkit install --local # Claude Code only
39
- ai-toolkit install --local --editors all # + all editors (Cursor, Windsurf, Cline, Roo, Aider, Augment, Copilot, Antigravity)
40
- ai-toolkit install --local --editors cursor,aider # + specific editors
41
- ai-toolkit update --local # auto-detects editors from existing project files
61
+ ai-toolkit install --local # Claude Code only
62
+ ai-toolkit install --local --editors all # + all editors
63
+ ai-toolkit install --local --editors cursor,aider # + specific editors
64
+ ai-toolkit update --local # auto-detects editors
42
65
  ```
43
66
 
44
67
  ### Plugin Management
45
68
 
46
69
  ```bash
47
- ai-toolkit plugin list # show available packs
48
- ai-toolkit plugin install --all # install all packs
49
- ai-toolkit plugin update --all # re-apply after toolkit updates
50
- ai-toolkit plugin status # show what's installed
51
- ai-toolkit plugin clean memory-pack --days 30 # prune old data
70
+ ai-toolkit plugin list # show available packs
71
+ ai-toolkit plugin install --editor all --all # install all for Claude + Codex
72
+ ai-toolkit plugin status --editor all # show what's installed
52
73
  ```
53
74
 
54
- After each `ai-toolkit update`, also run `ai-toolkit plugin update --all` to keep plugin hooks and scripts in sync.
55
-
56
75
  ### Install Profiles
57
76
 
58
77
  ```bash
59
- ai-toolkit install --profile minimal # agents + skills only (no hooks, no constitution)
78
+ ai-toolkit install --profile minimal # agents + skills only
60
79
  ai-toolkit install --profile standard # full install (default)
61
- ai-toolkit install --profile strict # full install + git hooks even without --local
62
- ```
63
-
64
- ### Persona Presets
65
-
66
- Personas adjust communication style, preferred skills, and code review priorities per engineering role.
67
-
68
- **Install-time (persistent — injected into CLAUDE.md):**
69
-
70
- ```bash
71
- ai-toolkit install --persona backend-lead # system design, API stability, data integrity
72
- ai-toolkit install --persona frontend-lead # component architecture, a11y, Core Web Vitals
73
- ai-toolkit install --persona devops-eng # infra-as-code, CI/CD, rollback safety
74
- ai-toolkit install --persona junior-dev # step-by-step explanations, learning focus
75
- ```
76
-
77
- **Runtime (session-scoped — no reinstall needed):**
78
-
79
- ```bash
80
- /persona backend-lead # activate for this session
81
- /persona --list # show available personas
82
- /persona --clear # reset to default
83
- ```
84
-
85
- ### Selective Install / Update
86
-
87
- ```bash
88
- ai-toolkit install --only agents,hooks # first-time: only listed components
89
- ai-toolkit install --skip hooks # first-time: skip listed components
90
- ai-toolkit update --only agents,hooks # re-apply: only listed components
91
- ai-toolkit update --skip cursor # re-apply: skip listed components
92
- ai-toolkit install --list # dry-run: show what would be applied
80
+ ai-toolkit install --profile strict # full + git hooks
93
81
  ```
94
82
 
95
83
  ### Verify & Repair
96
84
 
97
85
  ```bash
98
- ai-toolkit validate # check toolkit integrity
99
- ai-toolkit validate --strict # CI-grade: warnings = errors
100
- ai-toolkit doctor # diagnose install health, hooks, and artifact drift
101
- ai-toolkit doctor --fix # auto-repair: broken symlinks, missing hooks, stale artifacts
102
- ```
103
-
104
- ### Eject (standalone, no toolkit dependency)
105
-
106
- ```bash
107
- ai-toolkit eject # export to current directory
108
- ai-toolkit eject /path/to # export to custom directory
109
- ```
110
-
111
- 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`.
112
-
113
- ### Compile for Local Models (Ollama, LM Studio, Aider)
114
-
115
- ```bash
116
- ai-toolkit compile-slm # auto-detect model, default budget
117
- ai-toolkit compile-slm --model-size 8b # 2K token budget for 8B models
118
- ai-toolkit compile-slm --model-size 32b --lang python # 8K budget + Python rules
119
- ai-toolkit compile-slm --persona backend-lead # boost backend-relevant skills
120
- ai-toolkit compile-slm --format ollama # Ollama Modelfile SYSTEM block
121
- ai-toolkit compile-slm --dry-run # preview what gets included
86
+ ai-toolkit validate # check integrity
87
+ ai-toolkit doctor --fix # auto-repair
122
88
  ```
123
89
 
124
- Compiles the full toolkit (20K+ tokens) into a minimal system prompt that fits SLM context windows. Preserves safety constitution, compresses skills, and packs by value density. Supports 4 output formats: `raw`, `ollama`, `json-string`, `aider`.
90
+ See [CLI Reference](kb/reference/cli-reference.md) for all commands and options.
125
91
 
126
92
  ---
127
93
 
128
94
  ## Platform Support
129
95
 
130
- | Platform | Config Files | How | Scope |
131
- |----------|-------------|-----|-------|
132
- | Claude Code | `~/.claude/` | `ai-toolkit install` | global |
133
- | Cursor | `~/.cursor/rules` + `.cursor/rules/*.mdc` | `ai-toolkit install` / `--local` | global + project |
134
- | Windsurf | `~/.codeium/.../global_rules.md` + `.windsurf/rules/*.md` | `ai-toolkit install` / `--local` | global + project |
135
- | Gemini CLI | `~/.gemini/GEMINI.md` | `ai-toolkit install` | global |
136
- | GitHub Copilot | `.github/copilot-instructions.md` | `ai-toolkit install --local` | project |
137
- | Cline | `.clinerules/*.md` | `ai-toolkit install --local` | project |
138
- | Roo Code | `.roomodes` + `.roo/rules/*.md` | `ai-toolkit install --local` | project |
139
- | Aider | `.aider.conf.yml` + `CONVENTIONS.md` | `ai-toolkit install --local` | project |
140
- | Augment | `.augment/rules/ai-toolkit-*.md` | `ai-toolkit install --local` | project |
141
- | Google Antigravity | `.agent/rules/*.md` + `.agent/workflows/*.md` | `ai-toolkit install --local` | project |
142
- | Codex / OpenCode | `AGENTS.md` | `ai-toolkit agents-md` | project |
143
-
144
- > **Note:** Claude Code is always installed (primary platform with full feature support). Other editors are installed on demand with `--editors <list>` or auto-detected from existing project files. All platforms receive the same agent/skill catalog, guidelines, rules, language-specific rules, and registered custom rules. For editors lacking native bash lifecycle hooks, `--local` installs a Git hooks fallback (`.git/hooks/pre-commit`) to enforce quality gates pre-commit.
96
+ | Platform | Config Files | Scope |
97
+ |----------|-------------|-------|
98
+ | Claude Code | `~/.claude/` | global |
99
+ | Cursor | `~/.cursor/rules` + `.cursor/rules/*.mdc` | global + project |
100
+ | Windsurf | `~/.codeium/.../global_rules.md` + `.windsurf/rules/*.md` | global + project |
101
+ | Gemini CLI | `~/.gemini/GEMINI.md` | global |
102
+ | GitHub Copilot | `.github/copilot-instructions.md` | project |
103
+ | Cline | `.clinerules/*.md` | project |
104
+ | Roo Code | `.roomodes` + `.roo/rules/*.md` | project |
105
+ | Aider | `.aider.conf.yml` + `CONVENTIONS.md` | project |
106
+ | Augment | `.augment/rules/ai-toolkit-*.md` | project |
107
+ | Google Antigravity | `.agent/rules/*.md` + `.agent/workflows/*.md` | project |
108
+ | Codex CLI | `AGENTS.md` + `.agents/rules/*.md` + `.agents/skills/*` + `.codex/hooks.json` | project + global plugin |
109
+
110
+ > Claude Code is always installed (primary platform). Other editors on demand with `--editors`. All platforms receive the same agent/skill catalog, guidelines, and registered custom rules.
145
111
 
146
112
  ---
147
113
 
@@ -149,16 +115,15 @@ Compiles the full toolkit (20K+ tokens) into a minimal system prompt that fits S
149
115
 
150
116
  | Component | Count | Description |
151
117
  |-----------|-------|-------------|
152
- | `skills/` (task) | 29 | Slash commands: `/commit`, `/build`, `/deploy`, `/test`, `/skill-audit`, `/hipaa-validate`, ... |
118
+ | `skills/` (task) | 29 | Slash commands: `/commit`, `/build`, `/deploy`, `/test`, `/skill-audit`, ... |
153
119
  | `skills/` (hybrid) | 31 | Slash commands with agent knowledge base |
154
120
  | `skills/` (knowledge) | 32 | Domain knowledge auto-loaded by agents |
155
121
  | `agents/` | 44 | Specialized agents across 10 categories |
156
- | `hooks/` | 21 global + 5 skill-scoped | Quality gates, path safety, CLAUDE.md enforcement, notifications, prompt governance, subagent lifecycle, session-end handoff, usage tracking, config protection, MCP health, governance audit |
157
- | `plugins/` | 11 experimental opt-in packs | Domain bundles for security, research, frontend, enterprise, and 6 language packs (not part of the default install) |
158
- | `output-styles/` | 1 style | System prompt output style overrides (e.g. Golden Rules) |
122
+ | `hooks/` | 21 global + 5 skill-scoped | Quality gates, path safety, prompt governance, session lifecycle |
123
+ | `plugins/` | 11 packs | Opt-in domain bundles (security, research, frontend, enterprise, 6 language packs) |
159
124
  | `constitution.md` | 5 articles | Machine-enforced safety rules |
160
- | `rules/` | auto-injected | Rules injected into your CLAUDE.md on `install` / `update` |
161
- | `kb/` | reference docs | Architecture, operating models, procedures, and best practices |
125
+ | `rules/` | auto-injected | Language-specific and custom rules injected into your configs |
126
+ | `kb/` | reference docs | Architecture, procedures, and best practices |
162
127
 
163
128
  ---
164
129
 
@@ -168,49 +133,50 @@ Compiles the full toolkit (20K+ tokens) into a minimal system prompt that fits S
168
133
  ai-toolkit/
169
134
  ├── app/
170
135
  │ ├── agents/ # 44 agent definitions
171
- │ │ ├── orchestrator.md
172
- │ │ ├── backend-specialist.md
173
- │ │ ├── security-architect.md
174
- │ │ └── ... (41 more)
175
136
  │ ├── skills/ # 92 skills (task / hybrid / knowledge)
176
- │ │ ├── commit/ # /commit slash command
177
- │ │ ├── review/ # /review slash command
178
- │ │ ├── clean-code/ # knowledge skill (auto-loaded)
179
- │ │ └── ... (87 more)
180
137
  │ ├── rules/ # Auto-injected into your CLAUDE.md
181
- │ ├── hooks/ # Hook scripts (copied to ~/.softspark/ai-toolkit/hooks/)
182
- ├── session-start.sh # MANDATORY reminder + session context
183
- │ │ ├── guard-destructive.sh # Block rm -rf, DROP TABLE, etc.
184
- │ │ ├── guard-path.sh # Block wrong-user path hallucination
185
- │ │ ├── guard-config.sh # Block edits to linter/formatter configs
186
- │ │ ├── user-prompt-submit.sh # Prompt governance reminder
187
- │ │ ├── quality-check.sh # Multi-language lint on stop
188
- │ │ ├── quality-gate.sh # Block task completion on errors
189
- │ │ ├── save-session.sh # Persist session context
190
- │ │ ├── subagent-start.sh # Subagent scope reminder
191
- │ │ ├── subagent-stop.sh # Subagent completion checklist
192
- │ │ ├── pre-compact.sh # Save context before compaction
193
- │ │ ├── pre-compact-save.sh # Timestamped backup before compaction
194
- │ │ ├── session-end.sh # Session handoff snapshot
195
- │ │ ├── post-tool-use.sh # Lightweight feedback after edits
196
- │ │ ├── mcp-health.sh # MCP server availability check
197
- │ │ ├── governance-capture.sh # Security-sensitive op logging
198
- │ │ ├── commit-quality.sh # Conventional commit advisory
199
- │ │ ├── session-context.sh # Environment snapshot on start
200
- │ │ ├── track-usage.sh # Skill invocation tracking
201
- │ │ └── notify-waiting.sh # Cross-platform "Claude waiting" notification
202
- │ ├── hooks.json # Hook definitions (merged into settings.json)
203
- │ ├── plugins/ # Experimental plugin packs (opt-in, not part of default install)
138
+ │ ├── hooks/ # Hook scripts (21 entries, 12 lifecycle events)
139
+ │ ├── plugins/ # 11 experimental plugin packs (opt-in)
204
140
  │ ├── output-styles/ # System prompt output style overrides
205
141
  │ ├── constitution.md # 5 immutable safety articles
206
142
  │ └── ARCHITECTURE.md # Full system design
207
- ├── kb/ # Reference docs, architecture notes, procedures, plans
143
+ ├── kb/ # Reference docs, procedures, plans
208
144
  ├── scripts/ # Validation, install, evaluation scripts
209
- ├── tests/ # Bats test suite
145
+ ├── tests/ # Bats test suite (598 tests)
210
146
  └── CHANGELOG.md
211
147
  ```
212
148
 
213
- **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 `~/.softspark/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))
149
+ **Distribution:** Symlink-based for agents/skills, copy-based for hooks. Run `ai-toolkit update` after `npm install` — all projects pick up changes instantly. See [Distribution Model](kb/reference/distribution-model.md).
150
+
151
+ ---
152
+
153
+ ## Key Features
154
+
155
+ **Machine-enforced constitution** — 5-article safety constitution enforced via `PreToolUse` hooks that actually block `rm -rf`, `DROP TABLE`, and irreversible operations. Not just documentation.
156
+
157
+ **21 lifecycle hooks** — Executable scripts across 12 events (SessionStart → SessionEnd). Guards, governance, quality gates, session persistence, MCP health checks. See [Hooks Catalog](kb/reference/hooks-catalog.md).
158
+
159
+ **Security scanning** — `/skill-audit` for code-level risks, `/cve-scan` for dependency CVEs. Both CI-ready with exit codes.
160
+
161
+ **Iron Law enforcement** — `/tdd`, `debugging-tactics`, and `verification-before-completion` enforce non-negotiable gates with anti-rationalization tables. 15 skills total include rationalization resistance.
162
+
163
+ **Multi-language quality gates** — `Stop` hook runs lint + type checks across Python, TypeScript, PHP, Dart, Go after every response.
164
+
165
+ **Agent verification checklists** — 10 agents include exit criteria that must be met before presenting results.
166
+
167
+ **Two-stage review** — `/subagent-development` runs Implementer → Spec Review → Quality Review per task.
168
+
169
+ **Persistent memory** — `memory-pack` plugin: SQLite + FTS5 search across past sessions.
170
+
171
+ **Persona presets** — 4 roles (backend-lead, frontend-lead, devops-eng, junior-dev) adjust style and priorities.
172
+
173
+ **Config inheritance** — Enterprise `extends` system with constitution immutability and enforcement constraints. See [Enterprise Config Guide](kb/reference/enterprise-config-guide.md).
174
+
175
+ **68 language rules** — 13 languages, 5 categories each. Auto-detected or explicit `--lang`. See [Language Rules](kb/reference/language-rules.md).
176
+
177
+ **25 MCP templates** — Ready-to-use configs for GitHub, PostgreSQL, Slack, Sentry, and more. See [MCP Templates](kb/reference/mcp-templates.md).
178
+
179
+ See [Unique Features](kb/reference/unique-features.md) for detailed descriptions of all differentiators.
214
180
 
215
181
  ---
216
182
 
@@ -218,71 +184,38 @@ ai-toolkit/
218
184
 
219
185
  | Command | Purpose | Effort |
220
186
  |---------|---------|--------|
221
- | `/workflow <type>` | Pre-defined multi-agent workflow (15 types — see below) | max |
222
- | `/orchestrate` | Custom multi-agent coordination (3–6 agents, you define domains) | max |
223
- | `/swarm` | Parallel Agent Teams: `map-reduce`, `consensus`, or `relay` | max |
187
+ | `/workflow <type>` | Pre-defined multi-agent workflow (15 types) | max |
188
+ | `/orchestrate` | Custom multi-agent coordination (3–6 agents) | max |
189
+ | `/swarm` | Parallel Agent Teams: `map-reduce`, `consensus`, `relay` | max |
224
190
  | `/plan` | Implementation plan with task breakdown | high |
225
191
  | `/review` | Code review: quality, security, performance | high |
226
192
  | `/debug` | Systematic debugging with diagnostics | medium |
227
193
  | `/refactor` | Safe refactoring with pattern analysis | high |
228
- | `/explore` | Interactive codebase visualization and discovery | medium |
229
- | `/test` | Run tests (Python, JS/TS, PHP, Flutter, Go, Rust) | medium |
230
- | `/deploy` | Deploy with pre-flight checks | medium |
231
- | `/rollback` | Rollback deployment with state verification | medium |
232
- | `/ci` | Generate CI/CD pipeline configuration | medium |
233
- | `/migrate` | Database migration workflow | medium |
194
+ | `/tdd` | Test-driven development with red-green-refactor | high |
234
195
  | `/commit` | Structured commit with linting | medium |
235
196
  | `/pr` | Pull request with generated checklist | medium |
236
- | `/docs` | Generate README, API docs, architecture notes, changelogs | high |
237
- | `/hook-creator` | Scaffold a new Claude Code hook with validation conventions | high |
238
- | `/command-creator` | Scaffold a new slash command with frontmatter and workflow guidance | high |
239
- | `/agent-creator` | Scaffold a new specialized agent with tools and trigger guidance | high |
240
- | `/plugin-creator` | Scaffold an experimental plugin pack with manifest and optional modules | high |
241
- | `/skill-audit` | Scan skills/agents for security risks: dangerous patterns, secrets, permissions | medium |
242
- | `/cve-scan` | Scan project dependencies for known CVEs using native audit tools (npm, pip, composer, cargo, go, ruby, dart) | medium |
243
- | `/hipaa-validate` | Scan codebase for HIPAA compliance: PHI exposure, missing audit logging, unencrypted transmission/storage, access control gaps, temp file exposure, missing BAA references | medium |
244
- | `/analyze` | Code quality, complexity, and pattern analysis | medium |
245
- | `/fix` | Auto-fix lint/type errors | low |
246
- | `/build` | Build with issue detection | low |
247
- | `/lint` | Run linters and report issues | low |
248
- | `/health` | Service health report | medium |
249
- | `/panic` | Emergency halt all autonomous operations | low |
250
- | `/write-a-prd` | Create PRD through interactive interview and module design | high |
251
- | `/prd-to-plan` | Convert PRD into phased vertical-slice implementation plan | high |
252
- | `/prd-to-issues` | Break PRD into GitHub issues with HITL/AFK tagging | medium |
253
- | `/tdd` | Test-driven development with red-green-refactor loop | high |
254
- | `/design-an-interface` | Generate 3+ radically different interface designs (parallel agents) | high |
255
- | `/grill-me` | Stress-test a plan through relentless Socratic questioning | medium |
256
- | `/ubiquitous-language` | Extract DDD-style glossary from conversation | medium |
257
- | `/refactor-plan` | Plan refactor with tiny commits via interview | high |
258
- | `/qa-session` | Interactive QA — report bugs, file GitHub issues | high |
197
+ | `/docs` | Generate README, API docs, architecture notes | high |
198
+ | `/explore` | Interactive codebase visualization | medium |
199
+ | `/write-a-prd` | Create PRD through interactive interview | high |
200
+ | `/prd-to-plan` | Convert PRD into vertical-slice implementation plan | high |
201
+ | `/design-an-interface` | Generate 3+ radically different interface designs | high |
202
+ | `/grill-me` | Stress-test a plan through Socratic questioning | medium |
259
203
  | `/triage-issue` | Triage bug with deep investigation and TDD fix plan | high |
260
- | `/architecture-audit` | Discover shallow modules, propose deepening refactors | high |
261
- | `/subagent-development` | Execute plans with 2-stage review (spec + quality) per task | high |
262
- | `/repeat` | Autonomous loop with safety controls (Ralph Wiggum pattern) | medium |
263
- | `/mem-search` | Search past coding sessions via natural language (memory-pack) | medium |
264
- | `/persona` | Switch engineering persona at runtime (session-scoped) | low |
265
- | `/council` | 4-perspective decision evaluation (Advocate, Critic, Pragmatist, User-Proxy) | high |
266
- | `/introspect` | Agent self-debugging with 7 failure pattern classification and recovery actions | medium |
204
+ | `/architecture-audit` | Discover shallow modules, propose refactors | high |
205
+ | `/council` | 4-perspective decision evaluation | high |
206
+ | `/cve-scan` | Scan dependencies for known CVEs | medium |
207
+ | `/skill-audit` | Scan skills/agents for security risks | medium |
208
+ | `/repeat` | Autonomous loop with safety controls | medium |
209
+ | `/persona` | Switch engineering persona at runtime | low |
267
210
 
268
211
  ### `/workflow` Types
269
212
 
270
- ```bash
271
- /workflow feature-development # New feature, full stack
272
- /workflow backend-feature # API + logic + tests
273
- /workflow frontend-feature # UI component + state + tests
274
- /workflow api-design # Design → implement → document
275
- /workflow database-evolution # Schema change + migration + code
276
- /workflow test-coverage # Boost coverage for a module
277
- /workflow security-audit # Multi-vector security assessment
278
- /workflow codebase-onboarding # Understand unfamiliar codebase
279
- /workflow spike # Time-boxed research → architecture note
280
- /workflow debugging # Bug spanning multiple layers
281
- /workflow incident-response # Production down
282
- /workflow performance-optimization # Degradation >50%
283
- /workflow infrastructure-change # Docker, CI/CD, infra
284
- /workflow application-deploy # Full deploy workflow
285
- /workflow proactive-troubleshooting # Warning / trend analysis
213
+ ```
214
+ feature-development backend-feature frontend-feature
215
+ api-design database-evolution test-coverage
216
+ security-audit codebase-onboarding spike
217
+ debugging incident-response performance-optimization
218
+ infrastructure-change application-deploy proactive-troubleshooting
286
219
  ```
287
220
 
288
221
  ### Multi-Agent Skill Selection
@@ -298,606 +231,42 @@ Need multi-agent coordination?
298
231
 
299
232
  ---
300
233
 
301
- ## Unique Differentiators
302
-
303
- ### 1. Machine-Enforced Constitution
304
-
305
- 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:
306
- - Mass deletion (`rm -rf`, `DROP TABLE`)
307
- - Blind overwrites of uncommitted work
308
- - Any action that could cause irreversible data loss
309
-
310
- ### 2. Hooks as Executable Scripts
311
-
312
- Hook logic lives in `app/hooks/*.sh` — not inline JSON one-liners. Scripts are copied to `~/.softspark/ai-toolkit/hooks/` on install and referenced from `~/.claude/settings.json`. Easy to read, debug, and extend.
313
-
314
- **12 lifecycle events / 21 global hook entries:**
315
-
316
- | Event | Script | Action |
317
- |-------|--------|--------|
318
- | SessionStart | `session-start.sh` | MANDATORY rules reminder + session context + instincts |
319
- | SessionStart | `mcp-health.sh` | Check MCP server command availability (non-blocking warning) |
320
- | SessionStart | `session-context.sh` | Capture environment snapshot (pwd, git branch, versions) to `~/.softspark/ai-toolkit/sessions/current-context.json` |
321
- | Notification | `notify-waiting.sh` | Cross-platform desktop notification |
322
- | PreToolUse | `guard-destructive.sh` | Block `rm -rf`, `DROP TABLE`, etc. |
323
- | PreToolUse | `guard-path.sh` | Block wrong-user path hallucination |
324
- | PreToolUse | `guard-config.sh` | Block edits to linter/formatter config files unless explicitly requested |
325
- | PreToolUse | `commit-quality.sh` | Advisory validation of git commit messages (conventional commits, length, no WIP) |
326
- | UserPromptSubmit | `user-prompt-submit.sh` | Prompt governance reminder for planning, research, and safe execution |
327
- | UserPromptSubmit | `track-usage.sh` | Record skill invocations to local stats |
328
- | PostToolUse | `post-tool-use.sh` | Lightweight validation reminders after edits |
329
- | PostToolUse | `governance-capture.sh` | Log security-sensitive operations to `~/.softspark/ai-toolkit/governance.log` (JSONL) |
330
- | Stop | `quality-check.sh` | Multi-language lint (ruff/tsc/phpstan/dart/go) |
331
- | Stop | `save-session.sh` | Persist session context for cross-session continuity |
332
- | TaskCompleted | `quality-gate.sh` | Block task completion on lint/type errors |
333
- | SubagentStart | `subagent-start.sh` | Narrow-scope reminder for spawned subagents |
334
- | SubagentStop | `subagent-stop.sh` | Completion checklist for subagent handoff |
335
- | PreCompact | `pre-compact.sh` | Smart compaction: prioritized context (instincts > tasks > git state > decisions) |
336
- | PreCompact | `pre-compact-save.sh` | Save timestamped context backup before compaction to `~/.softspark/ai-toolkit/compactions/` |
337
- | SessionEnd | `session-end.sh` | Persist a session-end handoff note |
338
- | TeammateIdle | *(inline)* | Completeness reminder |
339
-
340
- **5 skill-scoped hooks:**
341
-
342
- | Skill | Hook | Action |
343
- |-------|------|--------|
344
- | `/commit` | Pre | Run linter, block on failure |
345
- | `/test` | Post | Coverage check, report threshold |
346
- | `/deploy` | Post | Health check, rollback if degraded |
347
- | `/migrate` | Pre | Backup verification |
348
- | `/rollback` | Post | State verification |
349
-
350
- ### 3. Security Scanning
351
-
352
- Two complementary security tools:
353
-
354
- **`/skill-audit`** — scan skills and agents for code-level risks:
355
-
356
- ```bash
357
- /skill-audit # Interactive (Claude remediation)
358
- python3 scripts/audit_skills.py --ci # CI mode: exit 1 on HIGH
359
- ```
360
-
361
- Detects: `eval()`/`exec()`, hardcoded secrets, permission issues, bash risks.
362
-
363
- **`/cve-scan`** — scan project dependencies for known CVEs:
364
-
365
- ```bash
366
- /cve-scan # Auto-detect ecosystems, scan all
367
- python3 app/skills/cve-scan/scripts/cve_scan.py # Direct invocation
368
- python3 app/skills/cve-scan/scripts/cve_scan.py --json # Machine-readable
369
- ```
370
-
371
- Supports: npm, pip, composer, cargo, go, ruby, dart. Uses native audit tools — zero external deps.
372
-
373
- **Severity levels:** HIGH (blocks CI), WARN (should fix), INFO (review)
374
-
375
- ### 4. Effort-Based Model Budgeting
376
-
377
- Every skill declares an effort level used for model token budgeting:
378
- - `low` — lint, build, fix (fast, cheap)
379
- - `medium` — debug, analyze, ci
380
- - `high` — review, plan, refactor, docs
381
- - `max` — orchestrate, swarm, workflow
382
-
383
- ### 5. Multi-Language Quality Gates
384
-
385
- The `Stop` hook runs after every response across 5 languages:
386
-
387
- | Language | Lint | Type Check |
388
- |----------|------|-----------|
389
- | Python | ruff | mypy --strict |
390
- | TypeScript | ESLint/tsc | tsc --noEmit |
391
- | PHP | phpstan | phpstan |
392
- | Dart | dart analyze | dart analyze |
393
- | Go | go vet | go vet |
394
-
395
- ### 6. Iron Law Enforcement
396
-
397
- Three skills enforce non-negotiable quality gates with anti-rationalization tables:
398
-
399
- | Skill | Iron Law | What it prevents |
400
- |-------|----------|-----------------|
401
- | `/tdd` | `NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST` | Code written before test? Delete it. Start over. No exceptions. |
402
- | `debugging-tactics` | `NO FIXES WITHOUT ROOT CAUSE INVESTIGATION FIRST` | 4-phase debugging: root cause → pattern → hypothesis → fix. 3+ failed fixes → question architecture. |
403
- | `verification-before-completion` | `NO COMPLETION CLAIMS WITHOUT FRESH VERIFICATION EVIDENCE` | Gate function: IDENTIFY → RUN → READ → VERIFY → CLAIM. "Should work now" is not evidence. |
404
-
405
- Additionally, **15 core skills** include `## Common Rationalizations` tables — domain-specific excuses with rebuttals that prevent agent drift and shortcut-taking. Skills with rationalization tables: `/review`, `/debug`, `/refactor`, `/tdd`, `/plan`, `/docs`, `/analyze`, `security-patterns`, `testing-patterns`, `api-patterns`, `ci-cd-patterns`, `clean-code`, `performance-profiling`, `git-mastery`, `database-patterns`.
406
-
407
- ### Confidence Scoring & Self-Evaluation (`/review`)
408
-
409
- The `/review` skill outputs findings with per-issue confidence scores (1-10) and severity classification (critical/major/minor/nit). After completing a review, an LLM-as-Judge self-evaluation pass checks for blind spots: anchoring bias, assumption vs verification, missing unhappy paths, and calibrates confidence scores.
410
-
411
- ### Agent Verification Checklists
412
-
413
- 10 key agents include `## Verification Checklist` — exit criteria that MUST be met before presenting results. Each checklist is domain-specific:
414
-
415
- | Agent | Key exit criteria |
416
- |-------|------------------|
417
- | `code-reviewer` | Every finding has file:line + evidence, not just opinion |
418
- | `security-auditor` | Each finding includes proof-of-concept or exploit path |
419
- | `test-engineer` | No empty/placeholder tests, mocks only at boundaries |
420
- | `debugger` | Root cause identified, regression test added |
421
- | `backend-specialist` | Input validation, error format, query optimization |
422
- | `frontend-specialist` | Empty/loading/error states, accessibility, responsive |
423
- | `database-architect` | Migration tested on prod-like volume, rollback tested |
424
- | `performance-optimizer` | Baseline measured, profiler evidence attached |
425
- | `devops-implementer` | Dry run passed, rollback documented, no hardcoded secrets |
426
- | `documenter` | Code examples runnable, no placeholders, valid links |
427
-
428
- ### Skill Reference Routing
429
-
430
- 7 core skills include `## Related Skills` sections that suggest logical follow-up skills, improving discoverability:
431
-
432
- ```
433
- /review → found issues? → /debug, /tdd, /cve-scan, /analyze
434
- /debug → bug fixed? → /review, /tdd, /workflow incident-response
435
- /plan → approved? → /orchestrate, /write-a-prd, /grill-me
436
- ```
437
-
438
- ### Intent Capture Interview (`/onboard`)
439
-
440
- The `/onboard` skill now includes a Step 0 interview phase before setup — asking 5 targeted questions to capture undocumented project intent (common contributor mistakes, protected files, deployment model, non-obvious constraints, review culture). Answers customize the generated `CLAUDE.md`.
441
-
442
- ### 7. Two-Stage Review (`/subagent-development`)
443
-
444
- Per-task review pipeline inspired by [obra/superpowers](https://github.com/obra/superpowers):
445
-
446
- ```
447
- Implementer → Spec Compliance Review → Code Quality Review → Next Task
448
- ```
449
-
450
- - Implementer reports status: `DONE` / `DONE_WITH_CONCERNS` / `NEEDS_CONTEXT` / `BLOCKED`
451
- - Spec reviewer verifies: all requirements met, nothing extra, nothing missing
452
- - Quality reviewer checks: SOLID, naming, error handling, tests, security
453
- - Prompt templates included: `reference/implementer-prompt.md`, `spec-reviewer-prompt.md`, `code-quality-reviewer-prompt.md`
454
-
455
- ### 8. Ralph Wiggum Loop (`/repeat`)
456
-
457
- Autonomous agent loop with safety controls:
458
-
459
- ```bash
460
- /repeat 5m /test # run tests every 5 min until all pass
461
- /repeat --iterations 3 /review # max 3 review passes
462
- ```
463
-
464
- | Safety Control | Default |
465
- |----------------|---------|
466
- | Max iterations | 5 |
467
- | Circuit breaker | 3 consecutive failures → halt |
468
- | Min interval | 1 minute |
469
- | Exit detection | DONE / COMPLETE / ALL PASS |
470
- | Stats logging | Every iteration to `stats.json` |
471
-
472
- Constitution Article I, Section 4 enforces these limits.
473
-
474
- ### 9. Visual Brainstorming Companion
475
-
476
- Optional browser-based companion for `/write-a-prd` and `/design-an-interface`:
477
-
478
- - Ephemeral Node.js HTTP server (auto-kills after 30min idle)
479
- - Dark theme, responsive, zero external dependencies
480
- - Per-question routing: mockups/diagrams → browser, text/conceptual → terminal
481
- - Consent-based: offered once as its own message, never forced
482
-
483
- ### 10. Persistent Memory (`memory-pack` plugin)
484
-
485
- SQLite-based session memory (opt-in plugin pack):
486
-
487
- | Component | Purpose |
488
- |-----------|---------|
489
- | `observation-capture.sh` | PostToolUse hook — captures tool actions to SQLite |
490
- | `session-summary.sh` | Stop hook — AI-compress session observations |
491
- | `mem-search` skill | FTS5 full-text search across past sessions |
492
- | `<private>` tags | Content between tags stripped before storage |
493
- | Progressive disclosure | Summary (~500 tok) → relevant (~2k tok) → full |
494
-
495
-
496
-
497
- ### 11. Persona Presets
498
-
499
- 4 engineering personas that adjust Claude's communication style per role:
500
-
501
- | Persona | Focus | Key Skills |
502
- |---------|-------|------------|
503
- | `backend-lead` | System design, scalability, data integrity | `/workflow backend-feature`, `/tdd` |
504
- | `frontend-lead` | Component architecture, a11y, Core Web Vitals | `/design-an-interface`, `/review` |
505
- | `devops-eng` | IaC, CI/CD, blast radius, rollback safety | `/workflow infrastructure-change`, `/deploy` |
506
- | `junior-dev` | Step-by-step explanations, learning focus | `/explain`, `/explore`, `/debug` |
507
-
508
- Persistent via `--persona` at install time, or session-scoped via `/persona` runtime command.
509
-
510
- ### 12. KB Integration Protocol
511
-
512
- Agents follow a research-before-action protocol enforced via rules:
513
- 1. `smart_query()` or `hybrid_search_kb()` before any technical answer
514
- 2. Source citation mandatory (`[PATH: kb/...]`)
515
- 3. Strict order: KB → Files → External Docs → General Knowledge
516
-
517
- ---
518
-
519
- ## MCP Templates
520
-
521
- 25 ready-to-use MCP server configuration templates. Install any with a single command:
522
-
523
- ```bash
524
- ai-toolkit mcp add github slack # add GitHub + Slack MCP servers
525
- ai-toolkit mcp list # browse all 25 templates
526
- ai-toolkit mcp show postgres # inspect config before adding
527
- ```
528
-
529
- Templates include: GitHub, PostgreSQL, Slack, Sentry, Context7, Brave Search, Supabase, Cloudflare, Vercel, and 16 more. Each is a validated JSON config fragment merged into `.mcp.json`.
530
-
531
- ---
532
-
533
- ## Language Rules
534
-
535
- 68 language-specific coding rules across 13 languages: TypeScript, Python, Go, Rust, Java, Kotlin, Swift, Dart, C#, PHP, C++, Ruby, plus common rules. Each language has 5 rule categories: coding-style, testing, patterns, frameworks, security.
536
-
537
- ```bash
538
- ai-toolkit install --local # auto-detects project language, installs matching rules
539
- ai-toolkit install --local --lang typescript # explicit language selection
540
- ai-toolkit install --local --lang go,python # multiple languages
541
- ```
542
-
543
- `--local` automatically detects languages using two-phase detection: config markers (package.json, go.mod, Cargo.toml, etc.) plus source file extension scanning (.py, .ts, .go, etc.). `--lang` accepts aliases (`go`, `c++`, `cs`). Rules are injected into `CLAUDE.md` and auto-updated on `ai-toolkit update --local`.
544
-
545
- When `--editors` is used alongside detected or explicit languages, language rules are propagated to all configured editors — not just Claude. Each editor receives the full rule content in its native format:
546
-
547
- | Editor | Language rule file | Activation |
548
- |--------|-------------------|------------|
549
- | Cursor | `.cursor/rules/ai-toolkit-lang-<lang>.mdc` | `globs` per file type (e.g. `**/*.py`) |
550
- | Windsurf | `.windsurf/rules/ai-toolkit-lang-<lang>.md` | always loaded |
551
- | Cline | `.clinerules/ai-toolkit-lang-<lang>.md` | always loaded |
552
- | Roo Code | `.roo/rules/ai-toolkit-lang-<lang>.md` | always loaded |
553
- | Augment | `.augment/rules/ai-toolkit-lang-<lang>.md` | `agent_requested` with globs |
554
- | Antigravity | `.agent/rules/ai-toolkit-lang-<lang>.md` | always loaded |
555
-
556
- Registered rules (`ai-toolkit add-rule`) are also propagated to directory-based editor configs as `ai-toolkit-custom-<name>` files.
557
-
558
- ---
559
-
560
- ## Extension API
561
-
562
- Generic API for external tools to inject rules and hooks into the toolkit:
563
-
564
- ```bash
565
- # Rules — injected into CLAUDE.md with HTML markers
566
- ai-toolkit inject-rule ./jira-rules.md # idempotent, source-tagged block
567
- ai-toolkit remove-rule jira-rules
568
-
569
- # Hooks — injected into settings.json with _source tags
570
- ai-toolkit inject-hook ./my-hooks.json # idempotent, _source tagged
571
- ai-toolkit remove-hook my-hooks
572
- ```
573
-
574
- Injection is idempotent — re-running updates only the marked block, never touching content outside it. See [`kb/reference/extension-api.md`](kb/reference/extension-api.md).
575
-
576
- ---
577
-
578
- ## Manifest Install
579
-
580
- Module-level install granularity. Install only what you need:
581
-
582
- ```bash
583
- ai-toolkit install --modules core,agents,rules-typescript
584
- ai-toolkit install --local # auto-detects language, installs matching rules
585
- ai-toolkit status # show installed modules and versions
586
- ai-toolkit update # incremental re-install (only changed modules)
587
- ```
588
-
589
- Install state is tracked in `~/.softspark/ai-toolkit/state.json`. See [`kb/reference/manifest-install.md`](kb/reference/manifest-install.md).
590
-
591
- ---
592
-
593
- ## Plugin Packs (Opt-in)
594
-
595
- 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.
596
-
597
- | Pack | Domain | Agents | Skills | Hooks | Description |
598
- |------|--------|--------|--------|-------|-------------|
599
- | `security-pack` | security | 3 | 3 | 2 | Security auditing, threat modeling, OWASP checks |
600
- | `research-pack` | research | 4 | 4 | 1 | Multi-source research, synthesis, fact-checking |
601
- | `frontend-pack` | frontend | 3 | 3 | 1 | React/Vue/CSS craft, SEO, design engineering |
602
- | `enterprise-pack` | enterprise | 3 | 3 | 3 | Executive briefings, infra architecture, status reporting |
603
- | `memory-pack` | memory | 0 | 1 | 2 | SQLite-based persistent memory with FTS5 search across sessions |
604
- | `rust-pack` | rust | 0 | 1 | 0 | Rust ownership, borrowing, Cargo, tokio, serde patterns |
605
- | `java-pack` | java | 0 | 1 | 0 | Records, sealed classes, Spring Boot, JUnit 5 |
606
- | `csharp-pack` | csharp | 0 | 1 | 0 | Nullable refs, async/await, ASP.NET Core, EF Core |
607
- | `kotlin-pack` | kotlin | 0 | 1 | 0 | Coroutines, DSLs, sealed classes, Ktor, MockK |
608
- | `swift-pack` | swift | 0 | 1 | 0 | Protocol-oriented, SwiftUI, async/await, SPM |
609
- | `ruby-pack` | ruby | 0 | 1 | 0 | Blocks, Rails conventions, RSpec, ActiveRecord |
610
-
611
- All packs have `status: experimental`. Each has a `plugin.json` manifest and `README.md` with installation instructions.
612
-
613
- ---
614
-
615
- ## Config Inheritance (`extends`)
616
-
617
- Enterprise-grade configuration inheritance for multi-repo AI governance. Organizations define a shared base config published as an npm package, Git URL, or local path. Projects inherit via `.softspark-toolkit.json`:
618
-
619
- ```json
620
- {
621
- "extends": "@mycompany/ai-toolkit-config",
622
- "profile": "standard"
623
- }
624
- ```
625
-
626
- **Key capabilities:**
627
- - **Layered merge** — base config + project overrides, with deep merge for dicts, union for lists, project-wins for scalars
628
- - **Constitution immutability** — Articles I-V and base articles cannot be modified; projects can only ADD new articles (6+)
629
- - **Enforce constraints** — `requiredAgents`, `forbidOverride`, `minHookProfile`, `requiredPlugins`
630
- - **Override validation** — requires explicit `override: true` + justification (min 20 chars)
631
- - **Lock file** — `.softspark-toolkit.lock.json` pins resolved versions for reproducible installs
632
- - **Offline fallback** — uses cached configs from `~/.softspark/ai-toolkit/config-cache/` when registry unavailable
633
-
634
- ```bash
635
- ai-toolkit config create-base @mycompany/ai-toolkit-config # scaffold base package
636
- ai-toolkit config init --extends @mycompany/ai-toolkit-config # setup project
637
- ai-toolkit config validate # schema + extends + enforcement
638
- ai-toolkit config diff # project vs base differences
639
- ai-toolkit config check # CI enforcement gate (exit 0/1/2, --json)
640
- ```
641
-
642
- See [Enterprise Config Guide](kb/reference/enterprise-config-guide.md) for full documentation.
643
-
644
- ---
645
-
646
- ## Project Registry
647
-
648
- All projects installed with `--local` are automatically registered in `~/.softspark/ai-toolkit/projects.json`. Running `ai-toolkit update` propagates updates to all registered projects in parallel.
649
-
650
- ```bash
651
- ai-toolkit projects # list registered projects
652
- ai-toolkit projects --prune # remove stale (deleted) entries
653
- ai-toolkit projects remove /path # unregister specific project
654
- ai-toolkit update # global update + parallel update ALL projects
655
- ```
656
-
657
- ---
658
-
659
- ## Comparison
660
-
661
- | Feature | ai-toolkit | everything-claude-code | wshobson/agents | ruflo |
662
- |---------|---------------|----------------------|-----------------|-------|
663
- | Skills | 92 | 100+ | 146 | 20+ |
664
- | Agents | 44 | 30+ | 112 | 20+ |
665
- | Machine-enforced constitution | **Yes** | No (docs only) | No | No |
666
- | Skill-scoped lifecycle hooks | **Yes** | No | No | No |
667
- | Effort-based model budgeting | **Yes** | No | No | No |
668
- | Test suite | Yes (bats) | Yes (997 tests) | No | Yes |
669
- | npm/npx install | Yes | Yes | Yes | Yes |
670
- | Cross-tool support | **Cursor, Windsurf, Copilot, Gemini, Cline, Roo, Aider, Augment, Antigravity** | 5+ tools | Smithery | Limited |
671
- | Selective install | Yes | Yes | Yes (72 plugins) | No |
672
- | Session persistence | Yes | Yes | No | No |
673
- | Architecture notes | **Yes** | No | No | No |
674
- | KB/RAG integration | **Yes** | No | No | Yes |
675
- | License | MIT | MIT | MIT | MIT |
676
-
677
- ---
678
-
679
- ## Agent Teams
680
-
681
- Native support for `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1` — automatically enabled during `ai-toolkit install` / `update` via `env` in `~/.claude/settings.json`.
682
-
683
- Pre-configured team presets via `/teams`:
684
-
685
- | Preset | Agents | Use Case |
686
- |--------|--------|----------|
687
- | `review` | code-reviewer, security-auditor, performance-optimizer | PR review |
688
- | `debug` | debugger, backend-specialist, incident-responder | Multi-file bug |
689
- | `feature` | orchestrator, backend-specialist, frontend-specialist, test-engineer | Full feature |
690
- | `fullstack` | backend-specialist, frontend-specialist, database-architect, devops-implementer | Stack feature |
691
- | `research` | technical-researcher, data-analyst, prompt-engineer | Deep research |
692
- | `security` | security-architect, security-auditor, backend-specialist | Security audit |
693
- | `migration` | database-architect, backend-specialist, devops-implementer | DB migration |
694
-
695
- ---
234
+ ## Getting Started
696
235
 
697
- ## Cross-Tool Support
236
+ 1. **Customize CLAUDE.md** — add your project's tech stack, commands, and conventions at the top (above toolkit markers).
698
237
 
699
- | Tool | Config | Scope |
700
- |------|--------|-------|
701
- | Claude Code | `~/.claude/settings.json` (hooks), `~/.claude/` (agents, skills, constitution) | global |
702
- | Cursor | `~/.cursor/rules` | global |
703
- | Windsurf | `~/.codeium/windsurf/memories/global_rules.md` | global |
704
- | Gemini CLI | `~/.gemini/GEMINI.md` | global |
705
- | GitHub Copilot | `.github/copilot-instructions.md` | project |
706
- | Cline | `.clinerules` | project |
707
- | Roo Code | `.roomodes` | project |
708
- | Aider | `.aider.conf.yml` | project |
709
- | Augment | `.augment/rules/ai-toolkit-*.md` | project |
710
- | Google Antigravity | `.agent/rules/` + `.agent/workflows/` | project |
711
- | Codex / OpenCode | `AGENTS.md` | project |
712
-
713
- ```bash
714
- # First-time install (Claude + Cursor + Windsurf + Gemini)
715
- ai-toolkit install
716
-
717
- # After npm update — re-apply updated components
718
- ai-toolkit update
719
-
720
- # Init project (Claude Code configs only: CLAUDE.md, settings, constitution, language rules)
721
- ai-toolkit install --local
722
-
723
- # Init with all editors (Cursor, Windsurf, Cline, Roo, Aider, Augment, Copilot, Antigravity)
724
- ai-toolkit install --local --editors all
725
-
726
- # Update project — auto-detects editors from existing config files
727
- ai-toolkit update --local
728
- ```
729
-
730
- > `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.
731
-
732
- ---
733
-
734
- ## Session Persistence
735
-
736
- Context survives across Claude Code sessions:
737
-
738
- ```bash
739
- # Enabled by default after install
740
- # Saved to: .claude/session-context.md
741
- # Loaded on: SessionStart hook
742
- ```
743
-
744
- ---
745
-
746
- ## Hook Runtime Profiles
747
-
748
- ```bash
749
- # In .claude/settings.local.json
750
- {
751
- "env": {
752
- "TOOLKIT_HOOK_PROFILE": "minimal" # minimal | standard | strict
753
- }
754
- }
755
- ```
756
-
757
- | Profile | Description |
758
- |---------|-------------|
759
- | `minimal` | Destructive command guard only |
760
- | `standard` | All hooks (default) |
761
- | `strict` | Standard + coverage enforcement + strict type checks |
762
-
763
- ---
764
-
765
- ## Post-Install Setup
766
-
767
- 1. **Customize CLAUDE.md** — add your project's tech stack, commands, and conventions at the top (above the toolkit markers).
768
-
769
- 2. **Configure settings**:
770
- ```bash
771
- # .claude/settings.local.json
772
- {
773
- "mcpServers": { ... },
774
- "env": { "TOOLKIT_HOOK_PROFILE": "standard" }
775
- }
776
- ```
777
-
778
- 3. **Verify**:
779
- ```bash
780
- ai-toolkit validate
781
- ```
782
-
783
- 4. **Start**:
238
+ 2. **Start using skills:**
784
239
  ```
785
- /onboard # guided setup
240
+ /onboard # guided setup interview
786
241
  /explore # understand your codebase
787
242
  /plan # plan a feature
788
243
  ```
789
244
 
790
- ---
791
-
792
- ## CLI Reference
793
-
794
- ```
795
- Usage: ai-toolkit <command> [options]
796
- ```
797
-
798
- | Command | Description |
799
- |---------|-------------|
800
- | `install` | First-time global install into `~/.claude/` + Cursor, Windsurf, Gemini |
801
- | `install --local` | Claude Code configs only; add `--editors all` or `--editors cursor,aider` for other tools |
802
- | `update` | Re-apply toolkit after `npm install -g @softspark/ai-toolkit@latest` |
803
- | `update --local` | Re-apply + auto-detect editors from existing project files |
804
- | `reset --local` | Wipe all project-local configs and recreate from scratch (clean slate) |
805
- | `add-rule <rule.md> [name]` | Register rule in `~/.softspark/ai-toolkit/rules/` — auto-applied on every `update` |
806
- | `remove-rule <name> [dir]` | Unregister rule from `~/.softspark/ai-toolkit/rules/` and remove its block from `CLAUDE.md` |
807
- | `inject-hook <file.json>` | Inject external hooks into settings.json (idempotent, `_source` tagged) |
808
- | `remove-hook <name>` | Remove injected hooks by source name |
809
- | `mcp list` | List available MCP server templates (25 templates) |
810
- | `mcp add <name> [names...]` | Add MCP server template(s) to `.mcp.json` |
811
- | `mcp show <name>` | Show MCP template config details |
812
- | `mcp remove <name>` | Remove MCP server from `.mcp.json` |
813
- | `config validate [path]` | Validate `.softspark-toolkit.json` schema + extends + enforcement |
814
- | `config diff [path]` | Show project vs base config differences |
815
- | `config init [flags]` | Create `.softspark-toolkit.json` (`--extends`, `--profile`, `--no-extends`) |
816
- | `config create-base <name>` | Scaffold base config npm package |
817
- | `config check [path]` | CI enforcement gate (exit 0=pass, 1=fail, 2=no config; `--json`) |
818
- | `projects` | List registered projects (`--prune` to clean stale, `remove <path>`) |
819
- | `status` | Show installed modules and version |
820
- | `update` | Re-install with saved modules + update all registered projects |
821
- | `validate` | Verify toolkit integrity (`--strict` for CI-grade, warnings = errors) |
822
- | `doctor` | Diagnose install health, hooks, quick-win assets, and artifact drift |
823
- | `doctor --fix` | Auto-repair broken symlinks, missing hooks, stale artifacts |
824
- | `eject [dir]` | Export standalone config (no symlinks, no toolkit dependency) |
825
- | `plugin list` | Show available plugin packs with install status |
826
- | `plugin install <name>` | Install a plugin pack (hooks, scripts, verify agents/skills) |
827
- | `plugin install --all` | Install all 11 plugin packs |
828
- | `plugin update <name>` | Update a plugin pack (remove + reinstall, preserves data) |
829
- | `plugin update --all` | Update all installed plugin packs |
830
- | `plugin clean <name> [--days N]` | Prune old plugin data (default: 90 days) |
831
- | `plugin remove <name>` | Remove a plugin pack |
832
- | `plugin status` | Show installed plugins with data stats (DB size, observation count) |
833
- | `stats` | Show skill usage statistics (`--reset` to clear, `--json` for raw output) |
834
- | `benchmark --my-config` | Compare your installed config vs toolkit defaults vs ecosystem |
835
- | `benchmark-ecosystem` | Generate a benchmark snapshot for official Claude Code and external ecosystem repos |
836
- | `create skill <name>` | Scaffold new skill from template (`--template=linter\|reviewer\|generator\|workflow\|knowledge`) |
837
- | `sync` | Config portability via GitHub Gist (`--export`, `--push`, `--pull`, `--import`) |
838
- | `evaluate` | Run skill evaluation suite |
839
- | `uninstall` | Remove toolkit from `~/.claude/` |
840
- | `cursor-rules` | Generate `.cursorrules` in current dir |
841
- | `windsurf-rules` | Generate `.windsurfrules` in current dir |
842
- | `copilot-instructions` | Generate `.github/copilot-instructions.md` in current dir |
843
- | `gemini-md` | Generate `GEMINI.md` in current dir |
844
- | `cline-rules` | Generate `.clinerules` in current dir |
845
- | `roo-modes` | Generate `.roomodes` in current dir |
846
- | `aider-conf` | Generate `.aider.conf.yml` in current dir |
847
- | `conventions-md` | Generate `CONVENTIONS.md` for Aider (auto-loaded) |
848
- | `augment-rules` | Generate `.augment/rules/ai-toolkit.md` (legacy single file) |
849
- | `augment-dir-rules` | Generate `.augment/rules/ai-toolkit-*.md` (recommended) |
850
- | `cursor-mdc` | Generate `.cursor/rules/*.mdc` for Cursor (recommended) |
851
- | `windsurf-dir-rules` | Generate `.windsurf/rules/*.md` for Windsurf |
852
- | `cline-dir-rules` | Generate `.cline/rules/*.md` for Cline |
853
- | `roo-dir-rules` | Generate `.roo/rules/*.md` for Roo Code |
854
- | `antigravity-rules` | Generate `.agent/rules/` and `.agent/workflows/` for Google Antigravity |
855
- | `agents-md` | Regenerate `AGENTS.md` from agent definitions |
856
- | `llms-txt` | Generate `llms.txt` and `llms-full.txt` |
857
- | `generate-all` | Generate all platform configs at once |
858
- | `help` | Show help |
859
-
860
- **Options for `install` and `update`:**
861
-
862
- ```bash
863
- ai-toolkit install --only agents,hooks # apply only listed components
864
- ai-toolkit install --skip hooks # skip listed components
865
- ai-toolkit install --profile minimal # profile preset: minimal | standard | strict
866
- ai-toolkit install --persona backend-lead # persona preset: backend-lead | frontend-lead | devops-eng | junior-dev
867
- ai-toolkit install --local # Claude Code only (CLAUDE.md, settings, constitution, language rules)
868
- ai-toolkit install --local --editors all # Claude Code + all editors (Cursor, Windsurf, Cline, Roo, Aider, Augment, Copilot, Antigravity)
869
- ai-toolkit install --local --editors cursor,aider # Claude Code + specific editors
870
- ai-toolkit update --local # re-apply; auto-detects editors from existing project files
871
- ai-toolkit install --list # dry-run: show what would be applied
872
- ai-toolkit install --modules core,agents,rules-typescript # selective module install
873
- ai-toolkit install --lang typescript # explicit language for rules install
874
- ```
245
+ 3. **Verify your install:**
246
+ ```bash
247
+ ai-toolkit validate
248
+ ```
875
249
 
876
250
  ---
877
251
 
878
- ## Injecting Rules from Another Repo
879
-
880
- Any repo can register its rules so they are automatically injected into all AI tool configs on every `update`:
881
-
882
- ```bash
883
- cd /path/to/your-repo
884
- ai-toolkit add-rule ./jira-rules.md
885
- # Registered: 'jira-rules' ~/.softspark/ai-toolkit/rules/jira-rules.md
886
-
887
- ai-toolkit update
888
- # injects jira-rules into ~/.claude/CLAUDE.md, ~/.cursor/rules, Windsurf, Gemini
889
- ```
890
-
891
- Rules are stored in `~/.softspark/ai-toolkit/rules/` and re-applied on every `update`. Injection is **idempotent** — re-running updates only the marked block, never touching content outside it.
892
-
893
- To unregister:
894
-
895
- ```bash
896
- ai-toolkit remove-rule jira-rules
897
- # Removes from ~/.softspark/ai-toolkit/rules/ and strips the block from ~/.claude/CLAUDE.md
898
- ```
899
-
900
- See [`kb/reference/integrations.md`](kb/reference/integrations.md) for known integrations.
252
+ ## Documentation
253
+
254
+ | Topic | Link |
255
+ |-------|------|
256
+ | CLI Reference | [kb/reference/cli-reference.md](kb/reference/cli-reference.md) |
257
+ | Unique Features | [kb/reference/unique-features.md](kb/reference/unique-features.md) |
258
+ | Architecture Overview | [kb/reference/architecture-overview.md](kb/reference/architecture-overview.md) |
259
+ | Hooks Catalog | [kb/reference/hooks-catalog.md](kb/reference/hooks-catalog.md) |
260
+ | Language Rules | [kb/reference/language-rules.md](kb/reference/language-rules.md) |
261
+ | MCP Templates | [kb/reference/mcp-templates.md](kb/reference/mcp-templates.md) |
262
+ | Extension API | [kb/reference/extension-api.md](kb/reference/extension-api.md) |
263
+ | Manifest Install | [kb/reference/manifest-install.md](kb/reference/manifest-install.md) |
264
+ | Plugin Packs | [kb/reference/plugin-pack-conventions.md](kb/reference/plugin-pack-conventions.md) |
265
+ | Enterprise Config | [kb/reference/enterprise-config-guide.md](kb/reference/enterprise-config-guide.md) |
266
+ | Distribution Model | [kb/reference/distribution-model.md](kb/reference/distribution-model.md) |
267
+ | Ecosystem Comparison | [kb/reference/comparison.md](kb/reference/comparison.md) |
268
+ | Codex CLI Compatibility | [kb/reference/codex-cli-compatibility.md](kb/reference/codex-cli-compatibility.md) |
269
+ | Maintenance SOP | [kb/procedures/maintenance-sop.md](kb/procedures/maintenance-sop.md) |
901
270
 
902
271
  ---
903
272
 
@@ -911,7 +280,7 @@ See [SECURITY.md](SECURITY.md) for responsible disclosure policy.
911
280
 
912
281
  ## License
913
282
 
914
- MIT -- see [LICENSE](LICENSE).
283
+ MIT see [LICENSE](LICENSE).
915
284
 
916
285
  ## Changelog
917
286