obsidian

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Obsidian

Obsidian

Obsidian vault = a normal folder on disk.
Vault structure (typical)
  • Notes:
    *.md
    (plain text Markdown; edit with any editor)
  • Config:
    .obsidian/
    (workspace + plugin settings; usually don’t touch from scripts)
  • Canvases:
    *.canvas
    (JSON)
  • Attachments: whatever folder you chose in Obsidian settings (images/PDFs/etc.)
Obsidian 库 = 磁盘上的普通文件夹。
典型的库结构
  • 笔记:
    *.md
    (纯文本Markdown;可使用任意编辑器编辑)
  • 配置:
    .obsidian/
    (工作区 + 插件设置;通常不要通过脚本修改)
  • 画布:
    *.canvas
    (JSON格式)
  • 附件:在Obsidian设置中选择的任意文件夹(图片/PDF等)

Find the active vault(s)

查找当前激活的库

Obsidian desktop tracks vaults here (source of truth):
  • ~/Library/Application Support/obsidian/obsidian.json
obsidian-cli
resolves vaults from that file; vault name is typically the folder name (path suffix).
Fast “what vault is active / where are the notes?”
  • If you’ve already set a default:
    obsidian-cli print-default --path-only
  • Otherwise, read
    ~/Library/Application Support/obsidian/obsidian.json
    and use the vault entry with
    "open": true
    .
Notes
  • Multiple vaults common (iCloud vs
    ~/Documents
    , work/personal, etc.). Don’t guess; read config.
  • Avoid writing hardcoded vault paths into scripts; prefer reading the config or using
    print-default
    .
Obsidian桌面版在此处追踪所有库(权威来源):
  • ~/Library/Application Support/obsidian/obsidian.json
obsidian-cli
从该文件解析库信息;库名称通常为文件夹名称(路径后缀)。
快速查看“哪个库处于激活状态 / 笔记存储在哪里?”
  • 若已设置默认库:
    obsidian-cli print-default --path-only
  • 否则,读取
    ~/Library/Application Support/obsidian/obsidian.json
    并找到带有
    "open": true
    的库条目。
注意事项
  • 多库使用很常见(比如iCloud与
    ~/Documents
    、工作/个人库等)。不要猜测;请读取配置文件。
  • 避免在脚本中写入硬编码的库路径;优先读取配置或使用
    print-default
    命令。

obsidian-cli quick start

obsidian-cli 快速入门

Pick a default vault (once):
  • obsidian-cli set-default "<vault-folder-name>"
  • obsidian-cli print-default
    /
    obsidian-cli print-default --path-only
Search
  • obsidian-cli search "query"
    (note names)
  • obsidian-cli search-content "query"
    (inside notes; shows snippets + lines)
Create
  • obsidian-cli create "Folder/New note" --content "..." --open
  • Requires Obsidian URI handler (
    obsidian://…
    ) working (Obsidian installed).
  • Avoid creating notes under “hidden” dot-folders (e.g.
    .something/...
    ) via URI; Obsidian may refuse.
Move/rename (safe refactor)
  • obsidian-cli move "old/path/note" "new/path/note"
  • Updates
    [[wikilinks]]
    and common Markdown links across the vault (this is the main win vs
    mv
    ).
Delete
  • obsidian-cli delete "path/note"
Prefer direct edits when appropriate: open the
.md
file and change it; Obsidian will pick it up.
设置默认库(仅需一次):
  • obsidian-cli set-default "<vault-folder-name>"
  • obsidian-cli print-default
    /
    obsidian-cli print-default --path-only
搜索
  • obsidian-cli search "query"
    (搜索笔记名称)
  • obsidian-cli search-content "query"
    (搜索笔记内容;显示片段和行号)
创建笔记
  • obsidian-cli create "Folder/New note" --content "..." --open
  • 需要Obsidian URI处理器(
    obsidian://…
    )正常工作(需已安装Obsidian)。
  • 避免通过URI在“隐藏”的点文件夹下创建笔记(例如
    .something/...
    );Obsidian可能会拒绝该操作。
移动/重命名(安全重构)
  • obsidian-cli move "old/path/note" "new/path/note"
  • 更新整个库中的
    [[wikilinks]]
    和普通Markdown链接(这是相比
    mv
    命令的主要优势)。
删除笔记
  • obsidian-cli delete "path/note"
在合适的情况下优先直接编辑:打开
.md
文件进行修改;Obsidian会自动同步更改。