name: obsidian description: “通过obsidian-cli操作Obsidian,创建丰富的视觉笔记,包含LaTeX、图像、颜色、标注和画布。充分利用Obsidian的潜力嵌入图像、使用Markdown格式化、创建彩色画布节点、图表,并利用高级功能。当用户提到Obsidian、obsidian-cli、vaults、notes或想要丰富的文档时使用。”
Obsidian CLI
使用 obsidian-cli(Yakitrak)管理笔记和vaults。
何时使用
- 用户询问关于Obsidian。
- 用户想要管理笔记(打开、搜索、创建、移动、删除)。
- 用户想要包含LaTeX、标注或图表的丰富文档。
- 用户询问画布、图表或
.canvas文件。
核心理念:用户驱动设计
在创建复杂结构之前询问用户的偏好。虽然您可以创建丰富的视觉笔记,但始终检查他们是否有特定要求:
- 深度:快速摘要 vs 详尽指南。
- 视觉元素:他们想要图像、LaTeX或Mermaid图表吗?
- 组织:应该是单个笔记、文件夹结构、幻灯片还是画布?
快速开始
- Vault管理:
obsidian-cli set-default "VaultName"— 切换默认vault(在不在正确vault时使用)。obsidian-cli print-default --path-only— 显示当前默认(在写入前验证vault)。
- 笔记操作:
obsidian-cli create "Note.md" --content "内容"obsidian-cli open "Note.md"obsidian-cli search-content "术语"obsidian-cli fm "Note.md" --edit --key "状态" --value "完成"
- CLI帮助和命令
obsidian-cli --helpobsidian-cli [command] --help
最佳实践
- Vault优先:在任何操作之前,使用
print-default检查当前vault;如果错误,运行obsidian-cli set-default "VaultName"然后继续。 - 先询问和计划:在写入文件之前,询问用户关于语调、结构和详细程度的偏好。提出笔记结构的简要计划或预览。
- 视觉和丰富内容:询问用户是否想要图表(Mermaid)、LaTeX或标注。如果会使笔记更有用和完整,主动搜索相关的高质量在线图像。
- 智能详细程度:根据上下文决定详细程度,但如果范围或细节级别不明确,明确询问用户。
- 画布设计:策略性地使用颜色:“1”(红色/紧急)、“3”(黄色/想法)、“4”(绿色/完成)、“5”(蓝色/信息)。
- 元数据和组织:始终包括YAML frontmatter以用于标签、状态和日期,确保笔记可发现和组织。
- 丰富和完整:以高质量、专业的结果为目标,充分利用Obsidian的潜力作为用户的“第二大脑”。
Vault:在任何操作前检查
在任何操作前始终验证您是否在正确的vault中。
- 在任何操作前(创建、打开、搜索、编辑、移动、删除、fm等):使用
obsidian-cli print-default --path-only(或没有--path-only以查看vault名称)检查当前默认vault。 - 如果目标vault与用户预期的vault不同:使用
obsidian-cli set-default "VaultName"切换(使用用户想要的确切vault名称)。 - 然后运行操作。
永远不要假设CLI已经在正确的vault上。如果用户指定了vault或您从上下文中推断出一个,确认它匹配默认值,并在不匹配时调用 set-default。
技术约束
- 路径相对于vault根目录。
- 对于包含空格的文件名使用引号。
- 画布中的文本节点支持完整的Markdown。
- 画布颜色是字符串 “1” 到 “6”。
- 不要在 .canvas 文件中添加注释。
额外资源
- Obsidian高级语法 - 官方指南,用于标注、高亮等。
- Obsidian风味Markdown - 官方文档,用于Mermaid、MathJax(LaTeX)和嵌入。
- 对于详细的画布JSON结构,请参阅 references/canvas-format.md
- 对于高级Markdown功能(LaTeX、标注、Mermaid),请参阅 references/markdown-features.md