docs: update README, install scripts for sessionStart.skill approach
This commit is contained in:
@@ -16,11 +16,9 @@ A Claude Code plugin serving as a complete engineering guide for **all programmi
|
||||
|
||||
Skills activate automatically when Claude detects relevant context (language, framework, topic).
|
||||
|
||||
### Hooks for Auto-Activation
|
||||
### Auto-Loaded Skill
|
||||
|
||||
| Hook | Trigger | What It Does |
|
||||
|------|---------|--------------|
|
||||
| **Stop** | Before stopping | Verifies mandatory skills are being applied (engineering-principles, clean-code, clean-architecture, testing, error-handling, security, git-workflow, api-design) |
|
||||
`engineering-principles` (29 principles) auto-loads at every session start — correctness, YAGNI, KISS, DRY, never assume, never suppress lints, show evidence, and more. This ensures foundational rules are always active.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -52,9 +50,9 @@ code-guide/
|
||||
├── .claude-plugin/
|
||||
│ └── plugin.json # Plugin manifest
|
||||
├── hooks/
|
||||
│ └── hooks.json # Hook configuration (Stop prompt)
|
||||
│ └── hooks.json # Reserved for future use
|
||||
├── skills/
|
||||
│ ├── clean-code/ # 23 more skill directories
|
||||
│ ├── clean-code/ # 24 skill directories
|
||||
│ └── ...
|
||||
└── README.md
|
||||
```
|
||||
@@ -66,4 +64,4 @@ Skills are in `skills/<name>/SKILL.md` format (modern Claude Code plugin convent
|
||||
- **Frontmatter** — `name` and `description` with trigger context
|
||||
- **Lean body** — key rules, examples, and anti-patterns
|
||||
|
||||
The Stop hook injects reminders when mandatory skills aren't being applied.
|
||||
The `engineering-principles` skill auto-loads via plugin.json's `sessionStart.skill` field (same pattern as Superpowers' `using-superpowers`).
|
||||
|
||||
+1
-1
@@ -30,4 +30,4 @@ if ($Link) {
|
||||
|
||||
Write-Host ""
|
||||
Write-Host "Done. Restart Claude Code or run /reload."
|
||||
Write-Host "Skills auto-trigger. Hooks auto-load from hooks/hooks.json."
|
||||
Write-Host "Skills auto-trigger. engineering-principles skill auto-loads at session start."
|
||||
|
||||
+2
-2
@@ -1,7 +1,7 @@
|
||||
#!/bin/bash
|
||||
# install.sh — code-guide installer for Claude Code
|
||||
# Installs the entire code-guide directory as one unit into ~/.claude/skills/.
|
||||
# Skills auto-discover, hooks auto-load from hooks/hooks.json.
|
||||
# Skills auto-discover, engineering-principles auto-loads at session start.
|
||||
# Usage:
|
||||
# ./install.sh # Copy code-guide to ~/.claude/skills/
|
||||
# ./install.sh --link # Symlink (edits live)
|
||||
@@ -41,4 +41,4 @@ if [ "$LINK_MODE" = true ]; then
|
||||
fi
|
||||
echo ""
|
||||
echo "Done. Restart Claude Code or run /reload."
|
||||
echo "Skills auto-trigger. Hooks auto-load from hooks/hooks.json."
|
||||
echo "Skills auto-trigger. engineering-principles skill auto-loads at session start."
|
||||
|
||||
Reference in New Issue
Block a user