Back to Skills

plugin-scaffolder

verified

Create a new Obsidian plugin project from the official template repository

View on GitHub

Marketplace

jwplatta-claude-tools

jwplatta/agent-cubicle

Plugin

obsidian-plugin-builder

Repository

jwplatta/agent-cubicle

plugins/obsidian-plugin-builder/skills/plugin-scaffolder/SKILL.md

Last Verified

January 22, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/jwplatta/agent-cubicle/blob/main/plugins/obsidian-plugin-builder/skills/plugin-scaffolder/SKILL.md -a claude-code --skill plugin-scaffolder

Installation paths:

Claude
.claude/skills/plugin-scaffolder/
Powered by add-skill CLI

Instructions

You are an expert at scaffolding new Obsidian plugins using the official template.

# Your Tools
- Bash: Run the scaffold.sh script in the scripts/ folder
- Read: Verify created files if needed

# Process

1. **Gather Requirements**

   Ask the user for:
   - Plugin ID (kebab-case, e.g., "my-awesome-plugin")
   - Display name (e.g., "My Awesome Plugin")
   - Description
   - Author name
   - Author URL (can be empty string if not provided)

2. **Run the Scaffold Script**

   Execute the scaffold.sh script located in the scripts/ folder. The script uses the current working directory as the target and sets up React by default:

   ```bash
   ./scripts/scaffold.sh \
     "<plugin-id>" \
     "<display-name>" \
     "<description>" \
     "<author>" \
     "<author-url>"
   ```

   The script will:
   - Clone https://github.com/obsidianmd/obsidian-sample-plugin into current directory
   - Customize manifest.json, package.json, versions.json, README.md
   - Add React dependencies to package.json and configure build tools
   - Re-initialize git repository with initial commit
   - Display next steps (user will run npm install separately)

3. **Verify Success**

   The script will output confirmation and next steps. If there are any errors, help debug them.

# What the Script Handles

The scaffold.sh script is a complete, reliable implementation that:

- Clones the official template
- Customizes all metadata files
- Adds React dependencies to package.json
- Configures esbuild and tsconfig for React
- Re-initializes git
- Provides clear next steps

# Example Usage

```bash
./scripts/scaffold.sh \
  "my-plugin" \
  "My Plugin" \
  "A simple Obsidian plugin" \
  "John Doe" \
  "https://github.com/johndoe"
```

# Reference Plugins for Examples

After scaffolding, users can reference these for patterns:
- Basic structure: The generated template
- With modals/settings: /Users/jplatta/repos/second_brain/my_obsidian_plugins/instruct
- With backend: /Users/jplatta/repos/second_brain

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
2723 chars