Complete reference for the official Obsidian CLI (v1.12+). All 115 commands documented.
This OpenClaw skill provides complete access to Obsidian's official CLI (v1.12+), enabling AI agents to:
- 📝 Automate note-taking: Create daily journals, meeting notes, project logs
- ✅ Manage tasks: Toggle task status, filter by completion, track progress
- 🔍 Search and organize: Find notes, create links, manage tags
- 🗄️ Work with databases: Query bases, create items, manage views
- 🎨 Customize workspace: Install themes/plugins, manage workspaces
For OpenClaw users: Your AI assistant can now read, write, and organize your Obsidian vault automatically.
For developers: Complete CLI reference with 115 commands for building Obsidian automation.
- Obsidian 1.12+ (free, public release)
- Platform: macOS, Windows, or Linux
- Obsidian must be running (CLI connects via IPC)
- Obsidian Publish subscription (optional, $8/month for publish commands)
clawhub install obsidian-cli-official# Add tap
brew tap alexanderkinging/tap
# Install
brew install obsidian-cli-official
# Test
obs help1. Enable CLI in Obsidian
Settings → General → Enable CLI
2. Add to PATH
echo 'export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"' >> ~/.zprofile
source ~/.zprofile3. Test
obsidian version
obsidian vault1. Enable CLI in Obsidian
Settings → General → Enable CLI
2. Add to PATH
Option A: System Environment Variables
- Press
Win + X→ System → Advanced system settings - Environment Variables → PATH → Edit
- Add:
C:\Users\<YourUsername>\AppData\Local\Obsidian
Option B: PowerShell Profile
# Edit profile
notepad $PROFILE
# Add this line
$env:PATH += ";$env:LOCALAPPDATA\Obsidian"
# Reload
. $PROFILE3. Test
obsidian version
obsidian vault1. Enable CLI in Obsidian
Settings → General → Enable CLI
2. Add to PATH
Snap:
# Already in PATH
obsidian versionFlatpak:
# Add alias to ~/.bashrc
echo 'alias obsidian="flatpak run md.obsidian.Obsidian"' >> ~/.bashrc
source ~/.bashrcAppImage:
# Move to ~/.local/bin
mv Obsidian-*.AppImage ~/.local/bin/obsidian
chmod +x ~/.local/bin/obsidian
# Add to PATH
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc3. Test
obsidian version
obsidian vaultYour AI assistant can maintain your daily journal automatically:
# Create today's daily note
obsidian daily
# Add morning tasks
obsidian daily:append content="## Morning Tasks\n- [ ] Review emails\n- [ ] Plan the day"
# Add meeting notes
obsidian daily:append content="## Meeting with Team\n- Discussed project timeline\n- Next steps: ..."AI agent creates structured meeting notes from conversations:
# Create meeting note
obsidian create name="Meeting 2026-03-01" content="# Team Sync\n\n## Attendees\n- Alice\n- Bob\n\n## Discussion\n..."
# Add metadata
obsidian property:set name="type" value="meeting" file="Meeting 2026-03-01"
obsidian property:set name="date" value="2026-03-01" file="Meeting 2026-03-01"
# Bookmark for quick access
obsidian bookmark file="Meeting 2026-03-01.md"AI agent helps you manage tasks across your vault:
# List all incomplete tasks
obsidian tasks daily todo
# Toggle task completion
obsidian task daily line=3 toggle
# Find tasks by tag
obsidian search query="- [ ]" path="Projects"AI agent finds and connects relevant information:
# Search for project notes
obsidian search query="project alpha" path="Work"
# Find related notes
obsidian backlinks file="Project Alpha"
# Check orphaned notes
obsidian orphansAI agent manages your Obsidian databases:
# List all databases
obsidian bases
# Query database
obsidian base:query file="Projects" format=json
# Create new item
obsidian base:create name="New Project" content="Description..."AI agent sets up your workspace:
# Install plugin
obsidian plugin:install id="dataview" enable
# Switch theme
obsidian theme:set name="Minimal"
# Save workspace layout
obsidian workspace:save name="coding"# Daily notes
obsidian daily
obsidian daily:append content="- [ ] Task"
# Files
obsidian create name="Note" content="Hello"
obsidian read file="Recipe"
obsidian search query="meeting"
# Tasks
obsidian tasks daily todo
obsidian task daily line=3 toggle
# Tags & Properties
obsidian tags counts sort=count
obsidian property:set name="status" value="done" file="Note"
# Bookmarks
obsidian bookmark file="important.md"
obsidian bookmarks
# Bases (Database)
obsidian bases
obsidian base:query file="MyBase" format=json
# History
obsidian history file="Note"
obsidian history:restore file="Note" version=3
# Plugins
obsidian plugins filter=community
obsidian plugin:install id="dataview" enable
# Publish (requires subscription)
obsidian publish:status
obsidian publish:add changed
# Developer
obsidian devtools
obsidian eval code="app.vault.getFiles().length"- Keep Obsidian running: CLI requires Obsidian app to be open
- Use
file=for flexibility: Resolves by name, works across folders - Batch operations: Combine commands for complex workflows
- Error handling: Check if Obsidian is running before CLI calls
Daily workflow automation:
# Morning routine
obsidian daily
obsidian daily:append content="## Today's Goals\n- [ ] Review PRs\n- [ ] Write docs"
obsidian tasks daily todoNote creation with metadata:
# Create note with properties
obsidian create name="Article Idea" content="# New Article\n\nIdea: ..."
obsidian property:set name="status" value="draft" file="Article Idea"
obsidian property:set name="tags" value="writing" file="Article Idea"
obsidian bookmark file="Article Idea.md"Search and link:
# Find related notes and create connections
obsidian search query="machine learning" path="Research"
obsidian backlinks file="ML Overview"
obsidian links file="ML Overview"Workspace setup:
# Set up coding environment
obsidian workspace:load name="coding"
obsidian plugin:enable id="dataview"
obsidian theme:set name="Minimal"# Check if Obsidian is running
if pgrep -x "Obsidian" > /dev/null; then
obsidian daily
else
echo "Please start Obsidian first"
fiSee SKILL.md for all 115 commands with full parameter documentation.
- Ensure Obsidian is running
- Enable CLI in Settings → General → Enable CLI
# Add to PATH
export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"
# Or use full path
/Applications/Obsidian.app/Contents/MacOS/obsidian version- Use
file=<name>for wikilink-style resolution (no path, no .md) - Use
path=<path>for exact paths (include folder and .md)
# Target specific vault (must be FIRST parameter)
obsidian vault="Work" daily
obsidian vault="Notes" search query="test"- Requires Obsidian Publish subscription ($8/month or $96/year)
- Without subscription:
Error: Command "publish:status" not found - Subscribe at: https://obsidian.md/publish
- Official Docs: https://help.obsidian.md/cli
- Obsidian Download: https://obsidian.md/download
- GitHub: https://github.com/alexanderkinging/obsidian-official-cli
- ClawHub: https://clawhub.ai/obsidian-cli-official
这个 OpenClaw skill 提供了 Obsidian 官方 CLI 的完整访问（v1.12+），让 AI agent 能够：
- 📝 自动化笔记: 创建日记、会议记录、项目日志
- ✅ 管理任务: 切换任务状态、筛选、追踪进度
- 🔍 搜索和整理: 查找笔记、创建链接、管理标签
- 🗄️ 操作数据库: 查询 base、创建条目、管理视图
- 🎨 自定义工作区: 安装主题/插件、管理工作区
对于 OpenClaw 用户: 你的 AI 助手现在可以自动读取、编写和整理你的 Obsidian 库。
对于开发者: 完整的 CLI 参考，包含 115 个命令，用于构建 Obsidian 自动化。
- Obsidian 1.12+（免费公开版本）
- 平台：macOS、Windows 或 Linux
- Obsidian 必须运行中
- Obsidian Publish 订阅（可选，$8/月，用于 publish 命令）
通过 ClawHub（所有平台）：
clawhub install obsidian-cli-official通过 Homebrew（macOS/Linux）：
brew install alexanderkinging/tap/obsidian-cli-officialmacOS:
- 设置 → 通用 → 启用 CLI
- 添加到 PATH：
export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS" - 测试：
obsidian version
Windows:
- 设置 → 通用 → 启用 CLI
- 添加到 PATH：系统属性 → 环境变量 → PATH → 添加
C:\Users\<用户名>\AppData\Local\Obsidian - 测试：
obsidian version
Linux:
- 设置 → 通用 → 启用 CLI
- 根据安装方式配置（Snap/Flatpak/AppImage）
- 测试：
obsidian version
日记自动化:
obsidian daily
obsidian daily:append content="## 今日任务\n- [ ] 审查代码\n- [ ] 写文档"会议记录:
obsidian create name="会议 2026-03-01" content="# 团队同步\n\n..."
obsidian property:set name="类型" value="会议" file="会议 2026-03-01"任务管理:
obsidian tasks daily todo
obsidian task daily line=3 toggle知识搜索:
obsidian search query="项目" path="工作"
obsidian backlinks file="项目概览"详细文档见 SKILL.md。
