mcpField
O
obsidian-cli

obsidian-cli

github.com/breferrari生産性5.5k85 回インストール2 週間前に更新
リポジトリ

obsidian-cli について

obsidian-cli は、起動中の Obsidian インスタンスを obsidian コマンドラインから操作するスキルです。ナレッジベースやノートの操作に加え、プラグイン開発時の確認やアプリの調査コマンドも扱います。

主な機能

  1. 01ノートの読み取り、作成、追記
  2. 02ノート検索とデイリー項目の管理
  3. 03ノートのプロパティ設定とタスク管理
  4. 04名前やパスによるファイルとナレッジベースの指定
  5. 05プラグインの再読み込みとエラー、UI、コンソールの確認

活用シーン

  1. 01コマンドラインでノートを作成・更新
  2. 02指定したナレッジベースを検索
  3. 03デイリーノートに項目を追加
  4. 04プラグイン変更をテストしてアプリの動作を確認

インストール

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

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

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

詳細

Obsidian CLI

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

重要

macOS — CLI を使用する前に、Obsidian を一度開いてください。 macOS では、Obsidian のインスタンスが実行されていない場合、obsidian コマンドによって Electron アプリが起動し、最初の呼び出し時にウィンドウが一瞬表示されます。Obsidian が開いていれば、その後の CLI 呼び出しは実行中のインスタンスに引数を転送するため、ウィンドウがちらつくことはありません。対話型ワークフロー（スラッシュコマンド）では、セッションの開始時に Obsidian が開いていることを確認してください。Obsidian が開いていることを保証できない非対話型の環境（バックグラウンドフック、自動化、CI）では、Read / Grep / Glob を使ったファイルシステムの読み取りを推奨します。

コマンドリファレンス

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> — ウィキリンクと同様に解決されます（名前のみを指定し、パスや拡張子は不要です）
  • 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 やデバッガーの制御など、その他の開発者向けコマンドを確認できます。

コメント

Markdown 対応