obsidianmd/obsidian-api

Health v2 · maintenance only

Flags: no_releases

Adoption not part of the score

2315 stars · 271 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

TypeScript type definitions for the Obsidian plugin API, maintained by the Obsidian team. It enables developers to build Obsidian plugins with type-safe access to the vault, workspace, metadata cache, and UI extension points.

Use cases

• develop an obsidian plugin in typescript
• get autocomplete for the obsidian api
• access and modify files in an obsidian vault programmatically
• add custom views, commands, and settings tabs to obsidian
• register event handlers in an obsidian plugin
• build a plugin that reads markdown metadata like links and tags

When to choose

• you are writing an Obsidian plugin in TypeScript or JavaScript
• you want up-to-date, official type definitions for the Obsidian API
• you need typed access to vault, workspace, and metadata cache interfaces

When to avoid

• you want to script Obsidian from outside the app rather than build a plugin
• you are building an editor unrelated to Obsidian
• you need a runtime library - this package only ships type definitions

Facets

library · maturity active

sdk type-system plugin-system developer-tools developer-tools text-editors documentation cross-platform obsidian type-definitions plugin-development note-taking markdown plugins electron nodejs typescript

Member repositories

For agents

markdown · JSON · MCP: product_card(name="obsidianmd/obsidian-api")