obsidian

Obsidian

Obsidian Vault の操作には、公式の obsidian CLI を使用してください。Vault のファイルはプレーンな Markdown なので、より安全または高速な場合は直接ファイルを編集しても問題ありません。

要件

• Obsidian 1.12.7+ がインストールされていること。
• 設定 -> 一般 -> コマンドラインインターフェースが有効になっていること。
• obsidian が PATH に登録されていること。
• Obsidian アプリが実行中であること。CLI は実行中のアプリに接続します。

確認:

obsidian version
obsidian help

macOS での登録では、アプリに同梱された CLI を指す /usr/local/bin/obsidian が作成されます。Linux での登録では、バイナリが ~/.local/bin/obsidian にコピーされます。

Vault モデル

• ノート: *.md。
• 設定: .obsidian/。依頼がない限り編集しないでください。
• キャンバス: *.canvas JSON。
• 添付ファイル: Vault で設定されたフォルダ。
• 複数の Vault が一般的です。曖昧な場合は vault="<name>" を渡してください。

Obsidian デスクトップは Vault をここで追跡します:

• ~/Library/Application Support/obsidian/obsidian.json

コマンドパターン

obsidian <command> [name=value] [flag]
obsidian vault="Notes" search query="meeting notes" format=json

スペースを含むパラメータ値には引用符が必要です。有用な場合は出力をコピーするために --copy を追加してください。

一般的なコマンド

開く/読む:

obsidian open file=Recipe
obsidian open path="Inbox/Idea.md" newtab
obsidian read
obsidian read file=Recipe

検索:

obsidian search query="TODO" matches
obsidian search query="status::active" format=json
obsidian search:open query="project notes"

作成/変更:

obsidian create name="New Note"
obsidian create path="Inbox/Idea.md" content="# Idea"
obsidian append file=Note content="New line"
obsidian prepend file=Note content="After frontmatter"

移動/削除:

obsidian move file=Note to=Archive/
obsidian move path="Inbox/Old.md" to="Projects/New.md"
obsidian delete file=Note

デイリー/タスク:

obsidian daily
obsidian daily:read
obsidian daily:append content="- [ ] Review inbox"
obsidian tasks all todo
obsidian task file=Note line=8 done

プロパティ/リンク:

obsidian tags all counts
obsidian property:read file=Note name=status
obsidian property:set file=Note name=status value=done
obsidian backlinks file=Note
obsidian unresolved verbose counts

開発者/デバッグ:

obsidian plugin:reload my-plugin
obsidian dev:errors
obsidian dev:screenshot file=shot.png
obsidian eval "app.vault.getFiles().length"

注意事項

• file=<name> は Obsidian スタイルのファイル解決を使用します。path=<vault-relative.md> は完全一致です。
• Obsidian を認識した更新には、CLI の移動/削除/プロパティコマンドを優先してください。
• Vault のパスを特定した後、大量のテキスト変更には直接 Markdown を編集することを優先してください。
• ユーザーが明示的に要求しない限り、サードパーティの obsidian-cli に依存しないでください。