Plugin Settings

Manage per-project plugin settings via YAML frontmatter in .claude/plugin-name.local.md files.

Updated Apr 10, 2025
One-click install
npx skills add https://github.com/LeighAtkins/OpenPaint --skill plugin-settings-leighatkins
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Plugin Settings
Source: https://github.com/LeighAtkins/OpenPaint/tree/main/.claude/plugins/plugin-dev/skills/plugin-settings
Command: npx skills add https://github.com/LeighAtkins/OpenPaint --skill plugin-settings-leighatkins

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill provides a standardized pattern for managing plugin-specific settings and state on a per-project basis, allowing for flexible and context-aware plugin behavior without modifying core plugin code or committing sensitive information to version control.

Core Features & Use Cases

  • Per-Project Configuration: Store settings in .claude/plugin-name.local.md files within your project directory.
  • YAML Frontmatter: Use YAML for structured settings (e.g., enabled: true, mode: strict).
  • Markdown Body: Include additional context, prompts, or instructions in the markdown section.
  • Use Case: A code linting plugin can have different strictness levels or ignore patterns configured per project by using these settings files, ensuring tailored analysis without global changes.

Quick Start

Create a file named .claude/my-plugin.local.md in your project root with your desired settings.

Frequently Asked Questions about Plugin Settings

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I manage per-project plugin configurations without modifying core plugin code?

Per-project plugin configurations can be managed using `.claude/plugin-name.local.md` files. This pattern stores project-specific settings locally, allowing flexible plugin behavior without altering core code or committing sensitive data to version control.

What is the best way to store local plugin settings and state for individual projects?

The best way to store local plugin settings is using `.claude/plugin-name.local.md` files. These files support YAML frontmatter for structured configurations like strictness levels, alongside a markdown body for additional context or instructions.

How do I use YAML frontmatter to configure plugin behavior across different projects?

You can use YAML frontmatter within `.claude/plugin-name.local.md` files to define structured settings such as `enabled: true` or `mode: strict`. This allows customizable, context-aware plugin behavior tailored to each specific project.

Can I parse local configuration files using bash scripts for plugin hooks and commands?

Yes, the `.claude/plugin-name.local.md` configuration files are parsed via bash scripts. This enables hooks and commands to read the YAML frontmatter and markdown body, applying the project-specific settings during plugin execution.

Does this per-project configuration pattern work for adjusting code linting strictness levels?

Yes, a code linting plugin can use these local settings files to configure different strictness levels or ignore patterns per project. This ensures tailored analysis without requiring global changes to the plugin's default behavior.

When should I avoid committing plugin configuration files to version control?

You should avoid committing `.claude/plugin-name.local.md` files to version control when they contain sensitive information or environment-specific state. This pattern is designed to keep local configurations separate from the core repository.