obsidian-scaffold

Scaffold an Obsidian community plugin project with configuration files and a minimal plugin class.

6|2|Updated Jan 6, 2026
One-click install
npx skills add https://github.com/acaprino/anvil-toolset --skill obsidian-scaffold
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-scaffold
Source: https://github.com/acaprino/anvil-toolset/tree/main/plugins/obsidian-development/skills/obsidian-scaffold
Command: npx skills add https://github.com/acaprino/anvil-toolset --skill obsidian-scaffold

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation of new Obsidian community plugins, ensuring they meet bot compliance standards from the outset and saving developers significant setup time.

Core Features & Use Cases

  • Project Scaffolding: Generates a complete, bot-compliant project structure for new Obsidian plugins.
  • Configuration Files: Creates essential files like manifest.json, package.json, tsconfig.json, and esbuild.config.mjs.
  • Minimal Plugin Class: Includes a basic main.ts with onload and onunload methods.
  • Use Case: A developer wants to start building a new Obsidian plugin for note organization. They use this skill to quickly generate a boilerplate project that's ready for coding and passes automated checks.

Quick Start

Use the obsidian-scaffold skill to create a new Obsidian plugin.

Frequently Asked Questions about obsidian-scaffold

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

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

To scaffold a new Obsidian plugin, this skill generates a complete project structure including manifest.json, package.json, tsconfig.json, and esbuild configuration, providing essential dependencies for immediate TypeScript development.

What files do I need to start Obsidian plugin development with TypeScript and esbuild?

Starting Obsidian plugin development requires manifest.json, tsconfig.json, package.json, and esbuild.config.mjs. This skill creates these configuration files alongside a minimal plugin class to ensure bot compliance.

Does this Obsidian plugin scaffolding generate a minimal plugin class?

Yes, Obsidian plugin scaffolding includes a basic main.ts file containing a minimal plugin class with onload and onunload methods, allowing you to start coding core features immediately.

How do I ensure my new Obsidian community plugin passes bot compliance checks?

To ensure bot compliance for a new Obsidian community plugin, this scaffolding skill generates a project structure that meets automated check standards from the outset, preventing validation errors.

Can I use esbuild to bundle an Obsidian plugin created by this scaffolding tool?

Yes, the generated project includes an esbuild.config.mjs file specifically configured for bundling the Obsidian plugin, ensuring the TypeScript code compiles correctly into the required output format.

What is the best way to automate Obsidian plugin boilerplate creation?

Automating Obsidian plugin boilerplate creation is best handled by scaffolding tools that generate the complete project structure, including configuration files and a minimal plugin class, saving significant setup time.