Plugin Settings

Topics in the source

• Plugin Settings Pattern for Claude Code Plugins
• Overview
• File Structure
• Basic Template
• Example: Plugin State File
• Reading Settings Files
• From Hooks (Bash Scripts)
• From Commands

Plugins can store user-configurable settings and state in .claude/plugin-name.local.md files within the project directory. This pattern uses YAML frontmatter for structured configuration and markdown content for prompts or additional context. Key characteristics: File location: .claude/plugin-name.local.md in project root Structure: YAML frontmatter + markdown body Purpose: Per-project plugin configuration and state Usage: Read from hooks, commands, and agents Lifecycle: User-managed (not in git, should be in .gitignore) .claude/my-plugin.local.md: Pattern: Check existence and parse frontmatter See examples/read-settings-hook.sh for complete working example. Commands can read settings files to customize behavior: Agents can reference settings in their instructions: String fields: Boolean fields: Numeric fields: Extract content after second ---: Use settings file to control hook activation: Use case: Enable/disable hooks without editing hooks.json (requires restart). Store agent-specific state and configuration: .claude/multi-agent-swarm.local.md: Read from hooks to coordinate agents: .claude/my-plugin.local.md: Use in hooks or commands: Commands can create settings files: Provide t

This is an excerpt. Refer to the complete source and its current requirements.