Slash Command175 repo starsupdated 3d ago

create-plugin

The create-plugin command guides developers through building a new Obsidian plugin using either automated or manual setup. Use this when starting plugin development to ensure the project structure follows best practices, including proper event cleanup, accessibility standards, TypeScript conventions, and Obsidian CSS variables from the outset.

View source Repository: obsidian-plugin-skill

Install in Claude Code

Copy

mkdir -p ~/.claude/commands && curl -fsSL https://raw.githubusercontent.com/gapmiss/obsidian-plugin-skill/HEAD/.claude/commands/create-plugin.md -o ~/.claude/commands/create-plugin.md

Then start a new Claude Code session; the slash command loads automatically.

Definition

create-plugin.md

You are helping the user create a new Obsidian plugin. Follow these steps:

## Setup Options

Present the user with two options:

1. **Automated Setup** (Recommended): Use the interactive boilerplate generator script
   - Run: `node /path/to/obsidian-plugin-skill/tools/create-plugin.js`
   - This creates a minimal, best-practice plugin structure automatically
   - Detects existing projects and only adds missing files
   - All generated code follows the Obsidian Plugin Development Skill guidelines

2. **Manual Setup**: Guide the user through creating files step-by-step
   - Walk through each required file
   - Explain what each file does
   - Provide code that follows best practices from the skill

## After Setup

Once the boilerplate is created (either way):

1. Verify all files follow the skill's best practices:
   - No sample code (MyPlugin, SampleModal, etc.)
   - Proper use of registerEvent() for cleanup
   - Sentence case in UI text
   - Obsidian CSS variables in styles
   - Accessibility-ready templates

2. Help customize the plugin:
   - Ask what the plugin will do
   - Suggest appropriate API usage patterns
   - Reference specific sections of the skill as needed

3. Guide through initial development:
   - Setting up the dev environment
   - Testing in Obsidian
   - Common next steps

## Important Reminders

- Always apply the Obsidian Plugin Development Skill guidelines
- Ensure accessibility from the start (keyboard navigation, ARIA labels, focus indicators)
- Use TypeScript best practices (instanceof, not type casting)
- Follow memory management rules (proper event registration)
- Use Obsidian CSS variables for theming

Ask the user which setup option they prefer, then proceed accordingly.