mcpField
O
obsidian-cli

obsidian-cli

github.com/timlai666生産性042 回インストール1 日前に更新
リポジトリ

obsidian-cli について

obsidian-cli は、起動中の Obsidian と `obsidian` コマンドラインインターフェースで連携するためのスキルです。ノートや保管庫の操作に加え、プラグインとテーマの開発手順も扱います。

主な機能

  1. 01ノートの読み取り・作成・追記
  2. 02保管庫内の検索
  3. 03デイリーノートとタスクの管理
  4. 04ノートプロパティの設定
  5. 05ファイルと保管庫の指定
  6. 06プラグインとテーマ開発のガイド

活用シーン

  1. 01コマンドラインからノートを作成・更新
  2. 02指定した保管庫内のノートを検索
  3. 03デイリーノートにタスクを追加
  4. 04Obsidian プラグインやテーマの開発・デバッグ

インストール

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

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

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

同梱ファイルreferences/plugin-development.md

詳細

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> — 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 を使用します。

プラグインとテーマの開発

Obsidian プラグインやテーマの開発またはデバッグを始める前に、 プラグイン開発を読んでください。完全なリロード、 エラーチェック、視覚的な検証のワークフローと、開発者向けコマンドの例が記載されています。

コメント

Markdown 対応