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