mcpField
O
obsidian-cli

obsidian-cli

github.com/obsidianmdその他51.7k84.9k 回インストール今日更新
リポジトリ

obsidian-cli について

Obsidian CLIは、起動中のObsidianインスタンスを操作するコマンドを解説する資料で、ユーザーやプラグイン開発者向けです。保管庫やファイルの指定、ノートとタスクの操作に加え、アプリの検査や開発用コマンドを扱います。

主な機能

  1. 01ノートの読み取り・作成・追記
  2. 02保管庫の検索とタスク管理
  3. 03名前やパスによるファイル・保管庫の指定
  4. 04出力のコピーとファイル表示の抑制
  5. 05プラグイン再読み込みとエラー確認

活用シーン

  1. 01コマンドラインからノートに内容を追加
  2. 02ノート検索やプロパティの更新
  3. 03デイリーノートとタスクの管理
  4. 04プラグイン再読み込みと問題の調査

インストール

コマンドをコピーしてターミナルで実行します。

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

インストール後、Claude Code で/obsidian-cliを入力して読み込まれたか確認します。

README（原文）English

プロジェクトの README より

この 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.

コメント

Markdown 対応