Quick Start

Get up and running with the Obsidian SDK in under 2 minutes.

Quick Start

Install

npm install obsidian-sdk

Set up the SDK

import { Obsidian } from "obsidian-sdk";

// Replace "myVault" with the name of the vault you want to work with.
const obsidian = new Obsidian({ vault: "myVault" });

Minimal example

// List files in the vault
const files = await obsidian.files.list();
console.log(files);

Running the example

node quickstart.js

All other modules follow the same pattern – instantiate the class via the obsidian instance and call the async methods.

Prerequisites

System requirements and setup needed before using the Obsidian SDK.

Notes

Full CRUD operations for markdown notes with YAML front-matter support.

On this page

Quick Start Install Set up the SDK Minimal example Running the example