Obsidian CLI

実行中の Obsidian インスタンスと相互作用するには obsidian CLI を使用します。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> — ボルトルートからの正確なパス (例: folder/note.md)

ボルトターゲティング

コマンドはデフォルトで最後にフォーカスされたボルトをターゲットにします。特定のボルトをターゲットにするには、最初のパラメータとして 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 およびデバッガコントロールを含む追加の開発者コマンドを確認します。