Loading source
Pulling the file list, source metadata, and syntax-aware rendering for this listing.
Source from repo
Pattern documentation for configuring settings in Claude Code plugins (from the official Anthropic claude-code repo).
Files
Skill
Size
Entrypoint
Format
Open file
Syntax-highlighted preview of this file as included in the skill package.
examples/example-settings.md
1# Example Plugin Settings File23## Template: Basic Configuration45**.claude/my-plugin.local.md:**67```markdown8---9enabled: true10mode: standard11---1213# My Plugin Configuration1415Plugin is active in standard mode.16```1718## Template: Advanced Configuration1920**.claude/my-plugin.local.md:**2122```markdown23---24enabled: true25strict_mode: false26max_file_size: 100000027allowed_extensions: [".js", ".ts", ".tsx"]28enable_logging: true29notification_level: info30retry_attempts: 331timeout_seconds: 6032custom_path: "/path/to/data"33---3435# My Plugin Advanced Configuration3637This project uses custom plugin configuration with:38- Standard validation mode39- 1MB file size limit40- JavaScript/TypeScript files allowed41- Info-level logging42- 3 retry attempts4344## Additional Notes4546Contact @team-lead with questions about this configuration.47```4849## Template: Agent State File5051**.claude/multi-agent-swarm.local.md:**5253```markdown54---55agent_name: database-implementation56task_number: 4.257pr_number: 567858coordinator_session: team-leader59enabled: true60dependencies: ["Task 3.5", "Task 4.1"]61additional_instructions: "Use PostgreSQL, not MySQL"62---6364# Task Assignment: Database Schema Implementation6566Implement the database schema for the new features module.6768## Requirements6970- Create migration files71- Add indexes for performance72- Write tests for constraints73- Document schema in README7475## Success Criteria7677- Migrations run successfully78- All tests pass79- PR created with CI green80- Schema documented8182## Coordination8384Depends on:85- Task 3.5: API endpoint definitions86- Task 4.1: Data model design8788Report status to coordinator session 'team-leader'.89```9091## Template: Feature Flag Pattern9293**.claude/experimental-features.local.md:**9495```markdown96---97enabled: true98features:99- ai_suggestions100- auto_formatting101- advanced_refactoring102experimental_mode: false103---104105# Experimental Features Configuration106107Current enabled features:108- AI-powered code suggestions109- Automatic code formatting110- Advanced refactoring tools111112Experimental mode is OFF (stable features only).113```114115## Usage in Hooks116117These templates can be read by hooks:118119```bash120# Check if plugin is configured121if [[ ! -f ".claude/my-plugin.local.md" ]]; then122exit 0 # Not configured, skip hook123fi124125# Read settings126FRONTMATTER=$(sed -n '/^---$/,/^---$/{ /^---$/d; p; }' ".claude/my-plugin.local.md")127ENABLED=$(echo "$FRONTMATTER" | grep '^enabled:' | sed 's/enabled: *//')128129# Apply settings130if [[ "$ENABLED" == "true" ]]; then131# Hook is active132# ...133fi134```135136## Gitignore137138Always add to project `.gitignore`:139140```gitignore141# Plugin settings (user-local, not committed)142.claude/*.local.md143.claude/*.local.json144```145146## Editing Settings147148Users can edit settings files manually:149150```bash151# Edit settings152vim .claude/my-plugin.local.md153154# Changes take effect after restart155exit # Exit Claude Code156claude # Restart157```158159Changes require Claude Code restart - hooks can't be hot-swapped.160