| | @@ -1,10 +1,15 @@ |
| 1 | 1 | # Explanatory Output Style Plugin |
| 2 | 2 | |
| 3 | | -This plugin recreates the deprecated Explanatory output style as a SessionStart hook. |
| 3 | +This plugin recreates the deprecated Explanatory output style as a SessionStart |
| 4 | +hook. |
| 4 | 5 | |
| 6 | +WARNING: Do not install this plugin unless you are fine with incurring the token |
| 7 | +cost of this plugin's additional instructions and output. |
| 8 | + |
| 5 | 9 | ## What it does |
| 6 | 10 | |
| 7 | | -When enabled, this plugin automatically adds instructions at the start of each session that encourage Claude to: |
| 11 | +When enabled, this plugin automatically adds instructions at the start of each |
| 12 | +session that encourage Claude to: |
| 8 | 13 | |
| 9 | 14 | 1. Provide educational insights about implementation choices |
| 10 | 15 | 2. Explain codebase patterns and decisions |
| | @@ -12,7 +17,9 @@ |
| 12 | 17 | |
| 13 | 18 | ## How it works |
| 14 | 19 | |
| 15 | | -The plugin uses a SessionStart hook to inject additional context into every session. This context instructs Claude to provide brief educational explanations before and after writing code, formatted as: |
| 20 | +The plugin uses a SessionStart hook to inject additional context into every |
| 21 | +session. This context instructs Claude to provide brief educational explanations |
| 22 | +before and after writing code, formatted as: |
| 16 | 23 | |
| 17 | 24 | ``` |
| 18 | 25 | `★ Insight ─────────────────────────────────────` |
| | @@ -20,15 +27,13 @@ |
| 20 | 27 | `─────────────────────────────────────────────────` |
| 21 | 28 | ``` |
| 22 | 29 | |
| 23 | | -## Installation |
| 24 | | - |
| 25 | | -Install this plugin from the Claude Code marketplace, or manually by placing it in your `.claude/plugins` directory. |
| 26 | | - |
| 27 | 30 | ## Usage |
| 28 | 31 | |
| 29 | | -Once installed, the plugin activates automatically at the start of every session. No additional configuration is needed. |
| 32 | +Once installed, the plugin activates automatically at the start of every |
| 33 | +session. No additional configuration is needed. |
| 30 | 34 | |
| 31 | 35 | The insights focus on: |
| 36 | + |
| 32 | 37 | - Specific implementation choices for your codebase |
| 33 | 38 | - Patterns and conventions in your code |
| 34 | 39 | - Trade-offs and design decisions |
| | @@ -36,7 +41,8 @@ |
| 36 | 41 | |
| 37 | 42 | ## Migration from Output Styles |
| 38 | 43 | |
| 39 | | -This plugin replaces the deprecated "Explanatory" output style setting. If you previously used: |
| 44 | +This plugin replaces the deprecated "Explanatory" output style setting. If you |
| 45 | +previously used: |
| 40 | 46 | |
| 41 | 47 | ```json |
| 42 | 48 | { |
| | @@ -46,11 +52,21 @@ |
| 46 | 52 | |
| 47 | 53 | You can now achieve the same behavior by installing this plugin instead. |
| 48 | 54 | |
| 49 | | -## Managing changes |
| 55 | +More generally, this SessionStart hook pattern is roughly equivalent to |
| 56 | +CLAUDE.md, but it is more flexible and allows for distribution through plugins. |
| 50 | 57 | |
| 51 | | -* Disable the plugin - keep the code installed on your device |
| 52 | | -* Uninstall the plugin - remove the code from your device |
| 53 | | -* Update the plugin - create a local copy of this plugin to personalize this plugin |
| 54 | | - - Hint: Ask Claude to read https://docs.claude.com/en/docs/claude-code/plugins.md and set it up for you! |
| 58 | +Note: Output styles that involve tasks besides software development, are better |
| 59 | +expressed as |
| 60 | +[subagents](https://docs.claude.com/en/docs/claude-code/sub-agents), not as |
| 61 | +SessionStart hooks. Subagents change the system prompt while SessionStart hooks |
| 62 | +add to the default system prompt. |
| 55 | 63 | |
| 64 | +## Managing changes |
| 56 | 65 | |
| 66 | +- Disable the plugin - keep the code installed on your device |
| 67 | +- Uninstall the plugin - remove the code from your device |
| 68 | +- Update the plugin - create a local copy of this plugin to personalize this |
| 69 | + plugin |
| 70 | + - Hint: Ask Claude to read |
| 71 | + https://docs.claude.com/en/docs/claude-code/plugins.md and set it up for |
| 72 | + you! |