Browse / Developer Tools / Plugin Settings Pattern

Plugin Settings Pattern

Establishes a standard pattern for making Claude Code plugins configurable on a per-project basis using local markdown files with YAML frontmatter.

SkillDeveloper ToolsSkill AuthoringDocs StandardsProject ManagementConfig

The source repository doesn't declare a license. Check its terms before reusing the code.

Key features

  • Utilizes YAML frontmatter for structured data and markdown for prompts or notes.
  • Covers best practices for defaults, validation, and `.gitignore` management.
  • Illustrates patterns for managing agent state and conditional hook execution.
  • Defines the `.claude/plugin-name.local.md` convention for per-project settings.
  • Includes shell script snippets for parsing configuration files in hooks.

Use cases

  • Creating a plugin with user-configurable behavior for different projects.
  • Allowing users to easily enable or disable a hook without editing plugin files.
  • Storing persistent state or multi-step instructions for an agent.

FAQ

How does this skill improve my AI development workflow?

It enables you to build flexible, reusable plugins that adapt to specific project needs. Instead of modifying plugin code, you simply create a local configuration file. This allows for powerful patterns like temporarily disabling hooks or managing complex AI agent states.

What is the Plugin Settings Pattern skill?

This skill documents the standard method for making Claude Code plugins configurable. It teaches you how to use `.claude/plugin-name.local.md` files with YAML frontmatter to store settings on a per-project basis, keeping them out of version control.

When should I use this skill?

Use this skill when building a Claude Code plugin that needs customizable behavior for different projects. It's essential for managing API keys, feature flags, validation levels, or agent state without hardcoding values into your plugin's logic.

What specific capabilities does this skill cover?

This skill provides a complete pattern including: a defined file structure (`.local.md` with YAML), Bash script snippets for parsing settings in hooks, best practices for default values and validation, and detailed examples for managing agent state and conditional hook execution.