obsidian-plugin-hot-reload

Automate local Obsidian plugin hot-reload loops with symlinked artifacts and CLI reloads.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/lc0rp/luke-agent-scripts --skill obsidian-plugin-hot-reload
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-plugin-hot-reload
Source: https://github.com/lc0rp/luke-agent-scripts/tree/main/skills/obsidian-plugin-hot-reload
Command: npx skills add https://github.com/lc0rp/luke-agent-scripts --skill obsidian-plugin-hot-reload

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates local Obsidian plugin development loops by establishing a reliable hot-reload workflow that rebuilds, symlinks artifacts into the vault, and reloads the plugin on changes.

Core Features & Use Cases

  • Auto-detects and prefers repo-local helpers (eg, start-local-hot-reload.sh) to orchestrate the loop.
  • Ensures the local server runs on port 8080 and injects KEEPSIDIAN_SERVER_URL into the watch build.
  • Symlinks plugin artifacts (main.js, manifest.json, styles.css) into the Obsidian vault and reloads the plugin automatically.
  • Watches build outputs (via fswatch or equivalent) and triggers Obsidian plugin reloads for rapid iteration.
  • Supports local-vault testing workflows and KeepSidian development setups.

Quick Start

Start the local hot-reload loop by using a repo-local helper if present, or follow the described steps to run the backend, symlink artifacts, run npm run dev, and watch for changes to reload the plugin.

Frequently Asked Questions about obsidian-plugin-hot-reload

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

FAQPage Schema
How do I set up hot-reload for Obsidian plugin development?

Hot-reload for Obsidian plugins is set up by running a local backend server, symlinking build artifacts into the vault, starting watch builds, and triggering automatic plugin reloads via the Obsidian CLI on file changes.

What is the hot-reload workflow for local Obsidian plugin testing?

The hot-reload workflow automates the local development loop by watching build outputs, symlinking artifacts like main.js and manifest.json into the Obsidian vault, and reloading the plugin automatically for rapid iteration.

Can I use a custom script to automate Obsidian plugin hot-reload?

Yes, the hot-reload loop auto-detects and prefers repo-local helper scripts like start-local-hot-reload.sh to orchestrate the build, symlink, and reload cycle for local-vault testing.

Do I need a specific port for the local server during Obsidian plugin development?

The local server must run on port 8080, and the workflow injects the KEEPSIDIAN_SERVER_URL environment variable into the watch build to ensure proper server coordination.

What artifacts are symlinked into the vault during Obsidian plugin hot-reload?

The hot-reload workflow symlinks plugin artifacts including main.js, manifest.json, and styles.css from the build output into the Obsidian vault directory before reloading the plugin.

Why is my Obsidian plugin not reloading after build changes?

Plugin reload fails if the watch build is not detecting changes via fswatch, if symlinks for artifacts like main.js are missing from the vault, or if the Obsidian CLI reload command is not triggered properly.