obsidian-cli

Obsidian CLI

obsidian CLI を使用して、実行中の Obsidian インスタンスとやり取りします。Obsidian が起動している必要があります。

コマンドリファレンス

obsidian help を実行すると、利用可能なすべてのコマンドを確認できます。これは常に最新の状態です。完全なドキュメント: https://help.obsidian.md/cli

構文

パラメータは = で値を指定します。スペースを含む値は引用符で囲みます:

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

フラグは値を持たないブール値のスイッチです:

obsidian create name="My Note" silent overwrite

複数行のコンテンツには、改行に \n、タブに \t を使用します。

ファイルの指定

多くのコマンドは、対象ファイルを指定するために file または path を受け付けます。どちらも指定しない場合は、アクティブなファイルが使用されます。

• file=<name> — wikilink のように解決されます（名前のみで、パスや拡張子は不要）
• path=<path> — vault ルートからの正確なパス（例: folder/note.md）

Vault の指定

コマンドはデフォルトで、最も最近フォーカスされた vault を対象とします。特定の vault を対象にするには、最初のパラメータとして vault=<name> を使用します:

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

一般的なパターン

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"

任意のコマンドで --copy を使用すると、出力をクリップボードにコピーできます。ファイルが開かないようにするには silent を使用します。リストコマンドで total を使用すると、件数を取得できます。

プラグイン開発

開発/テストサイクル

プラグインまたはテーマのコードを変更した後は、次のワークフローに従います:

1. プラグインをリロードして変更を反映します:

   obsidian plugin:reload id=my-plugin
   

2. エラーを確認します — エラーが表示された場合は修正し、手順 1 から繰り返します:

   obsidian dev:errors
   

3. スクリーンショットまたは DOM インスペクションで視覚的に検証します:

   obsidian dev:screenshot path=screenshot.png
   obsidian dev:dom selector=".workspace-leaf" text
   

4. 警告や予期しないログがないか、コンソール出力を確認します:

   obsidian dev:console level=error
   

その他の開発者向けコマンド

アプリのコンテキストで JavaScript を実行します:

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

CSS の値を検査します:

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

モバイルエミュレーションを切り替えます:

obsidian dev:mobile on

obsidian help を実行すると、CDP やデバッガー制御を含む、その他の開発者向けコマンドを確認できます。