Quick Start

Get the Obsidian SDK set up and running in your local environment.

Prerequisites

git clone https://github.com/MYSELF-SAYAN/obsidian_cli_api.git
cd obsidian-sdk

npm install

Create a .env file in the project root:

# Required: Your Obsidian vault name
OBSIDIAN_VAULT=myVault

# Optional: Custom port (default: 3000)
PORT=3000

Before using the SDK, start the Obsidian CLI server:

npm run server
# or
npx obsidian server

This starts the local API server on http://localhost:3000.

npm install obsidian-sdk

npm install -g obsidian-sdk

import { Obsidian } from "obsidian-sdk";

// Connect to your vault
const obsidian = new Obsidian({ vault: "myVault" });

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

// Read specific file content
const content = await obsidian.files.read("Notes.md");
console.log(content);

// Search for notes
const results = await obsidian.search.query("project");
console.log(results);

node examples/list-files.js

npm run examples

npm run dev

This starts a REPL where you can interact with the SDK methods directly.

If obsidian command is not found:

If port 3000 is occupied:

PORT=3001 npm run server

Verify your vault name matches exactly:

# List available vaults
curl http://localhost:3000/api/vault/list