plugin-scaffolder

Scaffold an Obsidian plugin project from the official template with React and TypeScript.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/jwplatta/prompt-library --skill plugin-scaffolder
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: plugin-scaffolder
Source: https://github.com/jwplatta/prompt-library/tree/main/claude/plugins/obsidian-plugin-builder/skills/plugin-scaffolder
Command: npx skills add https://github.com/jwplatta/prompt-library --skill plugin-scaffolder

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, jq, and includes scripts (resource) components.

What problem does it solve?

This Skill automates scaffolding a new Obsidian plugin project from the official template, ensuring a consistent, production-ready starting point.

Core Features & Use Cases

  • Template Scaffolding: Clone and tailor the official Obsidian plugin template.
  • Project Customization: Update manifest.json, package.json, versions.json, and README.md with your details.
  • React & Build Setup: Integrate React by default and configure build tooling (esbuild/tsconfig).
  • Version Control: Reinitialize Git to start with a clean history.
  • Use Case: Rapidly bootstrap a new plugin project for internal tools or a public release.

Quick Start

Run the scaffold script in the target directory: ./scripts/scaffold.sh "<plugin-id>" "<display-name>" "<description>" "<author>" "<author-url>"

Frequently Asked Questions about plugin-scaffolder

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

FAQPage Schema
How do I scaffold a new Obsidian plugin project?

Scaffolding an Obsidian plugin clones the official template and auto-configures manifest.json, package.json, versions.json, and README.md with your metadata. Run the scaffold script with your plugin ID, display name, description, author, and author URL to generate a production-ready project with React and build tooling already set up.

Can I create an Obsidian plugin with React and TypeScript from a template?

Yes, the scaffold automates template cloning and integrates React and TypeScript by default, configuring esbuild and tsconfig for immediate development without manual setup.

What files does the plugin scaffolder customize in the template?

The scaffolder updates manifest.json, package.json, versions.json, and README.md with your plugin details, then adds React dependencies and configures build tooling to match your project specifications.

Do I need Git and jq installed to use the plugin scaffolder?

Yes, the scaffolder requires git and jq as dependencies. It uses git to clone and reinitialize version control, and jq to parse and manipulate JSON configuration files during setup.

Why should I reinitialize Git history when creating a plugin?

Reinitializing Git history gives your plugin a clean commit log independent of the official template's history, providing a fresh start for version control and making your repository's history relevant only to your project.