@mikulgohil/ai-kit 1.10.0 → 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -123,13 +123,17 @@ Structured AI workflows applied automatically — the AI recognizes what you're
123
123
 
124
124
  ### Automated Quality Hooks
125
125
 
126
- | Profile | What Runs Automatically |
126
+ | Hook | What It Does |
127
127
  |---|---|
128
- | **Minimal** | Auto-format + git push safety |
129
- | **Standard** | + TypeScript type-check + console.log warnings + mistakes auto-capture + bundle impact warning |
130
- | **Strict** | + ESLint check + stop-time console.log audit + pre-commit AI review + bundle impact warning |
128
+ | **Session Init** | Echoes project stack, package manager, available scripts, and last scan date at every session start — the AI has full context from the first prompt |
129
+ | **Auto-format** | Formats files on edit via Prettier or Biome |
130
+ | **TypeScript check** | Catches type errors after every edit (standard + strict) |
131
+ | **Console.log warning** | Catches debug statements before commit (standard + strict) |
132
+ | **Mistakes auto-capture** | Logs build/lint failures to `docs/mistakes-log.md` automatically (standard + strict) |
133
+ | **Pre-commit review** | Checks for `any` types, console.logs, and TODOs without tickets in staged files (strict) |
134
+ | **Context re-echo** | After context compaction in long sessions, re-echoes tech stack (standard + strict) |
131
135
 
132
- **Mistakes auto-capture** When a build/lint command fails, the hook logs the error to `docs/mistakes-log.md` with timestamp and error preview. The mistakes log builds itself over time.
136
+ Three strictness profiles: **Minimal** (format + git safety), **Standard** (+ typecheck + warnings + mistakes), **Strict** (+ ESLint + pre-commit review).
133
137
 
134
138
  <br />
135
139
 
@@ -180,7 +184,9 @@ Period summaries, budget progress with alerts, per-project cost breakdown, week-
180
184
  | Command | Description |
181
185
  |---|---|
182
186
  | `ai-kit init [path]` | Scan project and generate all configs |
183
- | `ai-kit update [path]` | Re-scan and update generated files (safe merge) |
187
+ | `ai-kit update [path]` | Re-scan and update generated files (safe merge, auto-backup) |
188
+ | `ai-kit migrate [path]` | Adopt ai-kit in a project with existing CLAUDE.md — preserves custom rules |
189
+ | `ai-kit rollback [path]` | Restore configs from a previous backup created by `update` |
184
190
  | `ai-kit reset [path]` | Remove all AI Kit generated files |
185
191
  | `ai-kit health [path]` | One-glance A-F project health dashboard |
186
192
  | `ai-kit audit [path]` | Security and configuration health audit |
@@ -299,7 +305,25 @@ When your project evolves:
299
305
  npx @mikulgohil/ai-kit update
300
306
  ```
301
307
 
302
- Only content between `AI-KIT:START/END` markers is refreshed. Your custom rules and manual edits are preserved.
308
+ Every update **automatically backs up** your current configs to `.ai-kit/backups/` before writing. Only content between `AI-KIT:START/END` markers is refreshed your custom rules and manual edits are preserved.
309
+
310
+ If something goes wrong, roll back instantly:
311
+
312
+ ```bash
313
+ npx @mikulgohil/ai-kit rollback # Pick from available backups
314
+ npx @mikulgohil/ai-kit rollback --latest # Restore most recent backup
315
+ ```
316
+
317
+ ### Migrating an Existing Project
318
+
319
+ Already have a hand-written `CLAUDE.md`? Migrate without losing your custom rules:
320
+
321
+ ```bash
322
+ npx @mikulgohil/ai-kit migrate # Interactive — shows preview, asks confirmation
323
+ npx @mikulgohil/ai-kit migrate --dry-run # Preview changes without writing
324
+ ```
325
+
326
+ Your custom sections are placed at the top of the file. AI Kit's generated rules go inside `AI-KIT:START/END` markers below. Future `ai-kit update` only touches the marked section — your rules are preserved forever.
303
327
 
304
328
  ---
305
329
 
@@ -317,7 +341,7 @@ Only content between `AI-KIT:START/END` markers is refreshed. Your custom rules
317
341
 
318
342
  ## Requirements
319
343
 
320
- - Node.js 18+
344
+ - Node.js 20+
321
345
  - A project with `package.json`
322
346
  - Claude Code or Cursor (at least one AI tool)
323
347
 
@@ -330,7 +354,7 @@ Full documentation at **[ai-kit.mikul.me](https://ai-kit.mikul.me)**
330
354
  | Page | What You'll Learn |
331
355
  |---|---|
332
356
  | [Getting Started](https://ai-kit.mikul.me/getting-started) | Step-by-step setup walkthrough |
333
- | [CLI Reference](https://ai-kit.mikul.me/cli-reference) | All 14 commands with examples |
357
+ | [CLI Reference](https://ai-kit.mikul.me/cli-reference) | All 16 commands with examples |
334
358
  | [Skills & Commands](https://ai-kit.mikul.me/slash-commands) | All 48 skills with usage guides |
335
359
  | [What Gets Generated](https://ai-kit.mikul.me/what-gets-generated) | Detailed breakdown of every generated file |
336
360
  | [Hooks](https://ai-kit.mikul.me/hooks) | Hook profiles, mistakes auto-capture |