obsidian

obsidian

熱門

使用官方 obsidian CLI 操作 Obsidian 筆記庫:讀取、搜尋、建立、編輯筆記、任務、連結、屬性、外掛。

38萬星標
8.1萬分支
更新於 2026/7/23
SKILL.md
readonlyread-only
name
obsidian
description

使用官方 obsidian CLI 操作 Obsidian 筆記庫:讀取、搜尋、建立、編輯筆記、任務、連結、屬性、外掛。

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/;除非要求,否則避免編輯。
  • 畫布:*.canvas JSON。
  • 附件:筆記庫設定的資料夾。
  • 常見有多個筆記庫;當不明確時,請傳入 vault="<name>"

Obsidian 桌面版會在此處追蹤筆記庫:

  • ~/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 的移動/刪除/屬性指令。
  • 對於大量文字變更,在找到筆記庫路徑後,建議直接編輯 Markdown。
  • 除非使用者明確要求,否則不要依賴第三方 obsidian-cli