Agent skill · software engineering · jeremylongshore
obsidian-install-auth
Set up Obsidian plugin development environment with Node.js and TypeScript.
Why this skill is useful
Adds executable scripts for setting up an Obsidian plugin development environment, including cloning, dependency installation, and configuration that aren't in public docs.
What it needs
Requires git, node, npm installed locally. About 5k tokens when loaded. Last updated 2026-08-07. 2,604 stars on the source repository.
What this skill does
Obsidian Install & Auth Overview Set up a complete Obsidian plugin development environment: clone the official sample plugin, install TypeScript + esbuild, configure a dev vault with symlink, verify the build pipeline, and establish the manifest.json / versions.json contract. Prerequisites Node.js 18+ (LTS recommended) npm or pnpm package manager Obsidian desktop app installed (download from https://obsidian.md) Git for version control Instructions Step 1: Clone the Official Sample Plugin The sample plugin includes these key files: esbuild.config.mjs — bundler with watch mode and external handling tsconfig.json — TypeScript config targeting ES2018 with strict null checks manifest.json — plugin metadata Obsidian reads at load time src/main.ts — Plugin subclass with commands, settings, modal Step 2: Install Dependencies Step 3: Configure manifest.json Every Obsidian plugin requires a manifest.json at the project root: Required fields: id, name, version, minAppVersion, description, author. Rules: id must be lowercase kebab-case, match the folder name under .obsidian/plugins/ minAppVersion should be 1.5.0 or higher (supports modern APIs like processFrontMatter) isDesktopOnly: false unless you use Electron-only APIs (childprocess, fs, shell) Step 4: Create versions.json Maps each plugin version to the minimum Obsidian version it requires: Obsidian uses this to warn users on older versions that they cannot install your plugin. Update it every time you bump version in manifest.json. Step 5: Create a Development Vault Open this vault in Obsidian: File > Open vault > select ~/ObsidianDev. Step 6: Symlink Plugin into Dev Vault On Windows (admin terminal): Step 7: Build and Verify In Obsidian: 1. Settings > Community plugins > Enable community plugins 2. Find your plugin in the list, toggle it on 3. Open Developer Console (Ctrl+Shift+I) — look for your plugin's load message 4. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills jeremylongshore/obsidian-install-auth