Obsidian TypeScript API Reference

Community

Obsidian API surface for plugins

Authorjulianobarbosa
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This reference documents Obsidian's TypeScript plugin API, including App, Vault, Workspace, and their interactions.

Core Features & Use Cases

  • API surface: Core app subsystems and their methods.
  • Usage examples: Typical plugin integration patterns.
  • Lifecycle guidance: onload, onunload, and event handling.

Quick Start

Implement a minimal Obsidian plugin that uses the App and Vault APIs to create a new file on startup.

Dependency Matrix

Required Modules

typescript

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: Obsidian TypeScript API Reference
Download link: https://github.com/julianobarbosa/claude-code-skills/archive/main.zip#obsidian-typescript-api-reference

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.