skills.rest
julianobarbosa
julianobarbosaCOMMUNITY
Explore all skills by this author →
Website𝕏@julianobarbosaGitHub

api-reference

Manage complex Git histories with rebasing, cherry-picking, and bisecting.

7|1|Updated Jul 12, 2026
Search Tags:#typescript#api#plugin#workspace#obsidian
One-click install
npx skills add https://github.com/julianobarbosa/claude-code-skills --skill api-reference
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-reference
Source: https://github.com/julianobarbosa/claude-code-skills/tree/main/skills/obsidian-skill
Command: npx skills add https://github.com/julianobarbosa/claude-code-skills --skill api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires typescript, and includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive reference for Obsidian's plugin API surface, helping you build robust plugins and integrations.

Core Features & Use Cases

  • API surface: Core App, Vault, Workspace, and FileManager interfaces.
  • Usage examples: Code snippets to accelerate plugin development.
  • Lifecycle hooks: onload/onunload patterns for plugins.

Quick Start

Use the API surface definitions to scaffold a new Obsidian plugin.

Frequently Asked Questions about api-reference

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

FAQPage Schema
How do I access Obsidian's plugin API to build custom integrations?▼

Obsidian's plugin API provides core interfaces like App, Vault, Workspace, and FileManager that expose the platform's functionality. This reference documents the complete API surface with code examples to help you scaffold and develop robust plugins without trial-and-error.

What lifecycle hooks do I need to implement when creating an Obsidian plugin?▼

Obsidian plugins use onload and onunload lifecycle hooks to manage plugin initialization and cleanup. These patterns ensure proper resource management and are essential for reliable plugin behavior within the workspace.

Can I use TypeScript to develop Obsidian plugins?▼

Yes, Obsidian plugin development uses TypeScript as a core dependency. This reference provides TypeScript-based API definitions and code snippets to accelerate your plugin development.

Where can I find code examples for the Obsidian Workspace and FileManager interfaces?▼

This API reference includes usage examples and code snippets for Workspace and FileManager interfaces, helping you quickly implement common plugin operations without consulting external resources.

What's the fastest way to scaffold a new Obsidian plugin project?▼

Use the API surface definitions in this reference to scaffold your plugin structure. The documented interfaces and quick-start patterns for App, Vault, and Workspace eliminate setup uncertainty and reduce initial development time.

Related Skills

Explore More Software Engineering Skills→
doyled-itdoyled-it

obsidian-plugin-dev

Automate setup, testing, and publishing workflows for TypeScript-based Obsidian plugins.

Community
Advanced
yankeeinlondonyankeeinlondon
1

obsidian

Develop Obsidian plugins and themes using Vault, Workspace, and CodeMirror 6 APIs.

Community
Advanced
Rookie-RCRookie-RC

obsidian-plugin

Bootstrap Obsidian plugins from templates with TypeScript and manifest configuration.

Community
Advanced
OmegaiceOmegaice

endpoint-exploration

Document undocumented REST API endpoints through empirical testing and URL analysis.

Community
Intermediate