Obsidian は何をしますか？
公式の obsidian CLI を使用して Obsidian ボールトを操作します。ボールトファイルはプレーンな Markdown なので、より安全・高速な場合は直接ファイル編集も問題ありません。
要件
- Obsidian 1.12.7 以上がインストールされていること。
- 設定 → 一般 → コマンドラインインターフェース が有効になっていること。
obsidianが PATH に登録されていること。- Obsidian アプリが実行中であること。CLI は実行中のアプリに接続します。
確認:
obsidian version
obsidian help
macOS での登録は /usr/local/bin/obsidian を作成し、アプリにバンドルされた CLI を指します。Linux での登録はバイナリを ~/.local/bin/obsidian にコピーします。
ボールトモデル
- ノート:
*.md。 - 設定:
.obsidian/。依頼がない限り編集しないでください。 - キャンバス:
*.canvasJSON。 - 添付ファイル: ボールト設定のフォルダ。
- 複数のボールトが一般的です。曖昧な場合は
vault="<名前>"を指定してください。
Obsidian デスクトップは以下の場所でボールトを追跡します:
~/Library/Application Support/obsidian/obsidian.json
コマンドパターン
obsidian <コマンド> [名前=値] [フラグ]
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=<名前>は Obsidian 形式のファイル解決を使用します。path=<ボールト相対パス>.mdは正確なパスです。- Obsidian を認識した更新が必要な場合は、CLI の移動・削除・プロパティコマンドを優先してください。
- 大量のテキスト変更には、ボールトのパスを特定した上で直接 Markdown 編集を優先してください。
- ユーザーが明示的に要求しない限り、サードパーティ製の
obsidian-cliに依存しないでください。