mcpField
O
obsidian-cli

obsidian-cli

github.com/kepanoProductivity50.3k81.5k installsUpdated 6w ago
Repository

About obsidian-cli

obsidian-cli is a skill for using the `obsidian` CLI with an open Obsidian instance. It covers vault and note operations as well as plugin and theme development checks.

Key features

  1. 01Read, create, append, and search notes
  2. 02Target files and vaults
  3. 03Manage daily notes and properties
  4. 04Reload plugins and inspect errors
  5. 05Inspect app DOM, CSS, and console

Use cases

  1. 01Search a vault and copy command output
  2. 02Add content to a daily note
  3. 03Test plugin changes and inspect errors

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/kepano/obsidian-skills --skill obsidian-cli

After installing, type/obsidian-cliin Claude Code to confirm it loaded.

Details

From the project README

Obsidian CLI

Use the obsidian CLI to interact with a running Obsidian instance. Requires Obsidian to be open.

Command reference

Run obsidian help to see all available commands. This is always up to date. Full docs: https://help.obsidian.md/cli

Syntax

Parameters take a value with =. Quote values with spaces:

obsidian create name="My Note" content="Hello world"

Flags are boolean switches with no value:

obsidian create name="My Note" silent overwrite

For multiline content use \n for newline and \t for tab.

File targeting

Many commands accept file or path to target a file. Without either, the active file is used.

  • file=<name> — resolves like a wikilink (name only, no path or extension needed)
  • path=<path> — exact path from vault root, e.g. folder/note.md

Vault targeting

Commands target the most recently focused vault by default. Use vault=<name> as the first parameter to target a specific vault:

obsidian vault="My Vault" search query="test"

Common patterns

obsidian read file="My Note"
obsidian create name="New Note" content="# Hello" template="Template" silent
obsidian append file="My Note" content="New line"
obsidian search query="search term" limit=10
obsidian daily:read
obsidian daily:append content="- [ ] New task"
obsidian property:set name="status" value="done" file="My Note"
obsidian tasks daily todo
obsidian tags sort=count counts
obsidian backlinks file="My Note"

Use --copy on any command to copy output to clipboard. Use silent to prevent files from opening. Use total on list commands to get a count.

Plugin development

Develop/test cycle

After making code changes to a plugin or theme, follow this workflow:

  1. Reload the plugin to pick up changes: 
    obsidian plugin:reload id=my-plugin
  2. Check for errors — if errors appear, fix and repeat from step 1: 
    obsidian dev:errors
  3. Verify visually with a screenshot or DOM inspection: 
    obsidian dev:screenshot path=screenshot.png
obsidian dev:dom selector=".workspace-leaf" text
  4. Check console output for warnings or unexpected logs: 
    obsidian dev:console level=error
Additional developer commands

Run JavaScript in the app context:

obsidian eval code="app.vault.getFiles().length"

Inspect CSS values:

obsidian dev:css selector=".workspace-leaf" prop=background-color

Toggle mobile emulation:

obsidian dev:mobile on

Run obsidian help to see additional developer commands including CDP and debugger controls.

Comments

Markdown supported