Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
120 lines
2.9 KiB
Markdown
120 lines
2.9 KiB
Markdown
---
|
|
name: obsidian
|
|
description: "Work with Obsidian vaults using the official obsidian CLI: read/search/create/edit notes, tasks, links, properties, plugins."
|
|
homepage: https://obsidian.md/cli
|
|
metadata: { "openclaw": { "emoji": "💎", "requires": { "bins": ["obsidian"] } } }
|
|
---
|
|
|
|
# Obsidian
|
|
|
|
Use the official `obsidian` CLI for Obsidian vault work. Vault files are plain Markdown, so direct file edits are still fine when safer/faster.
|
|
|
|
## Requirements
|
|
|
|
- Obsidian 1.12.7+ installed.
|
|
- Settings -> General -> Command line interface enabled.
|
|
- `obsidian` registered on PATH.
|
|
- Obsidian app running; the CLI connects to the running app.
|
|
|
|
Check:
|
|
|
|
```bash
|
|
obsidian version
|
|
obsidian help
|
|
```
|
|
|
|
macOS registration creates `/usr/local/bin/obsidian` pointing at the app-bundled CLI. Linux registration copies the binary to `~/.local/bin/obsidian`.
|
|
|
|
## Vault model
|
|
|
|
- Notes: `*.md`.
|
|
- Config: `.obsidian/`; avoid editing unless asked.
|
|
- Canvases: `*.canvas` JSON.
|
|
- Attachments: vault-configured folder.
|
|
- Multiple vaults are common; pass `vault="<name>"` when ambiguous.
|
|
|
|
Obsidian desktop tracks vaults here:
|
|
|
|
- `~/Library/Application Support/obsidian/obsidian.json`
|
|
|
|
## Command pattern
|
|
|
|
```bash
|
|
obsidian <command> [name=value] [flag]
|
|
obsidian vault="Notes" search query="meeting notes" format=json
|
|
```
|
|
|
|
Parameter values with spaces need quotes. Add `--copy` to copy output where useful.
|
|
|
|
## Common commands
|
|
|
|
Open/read:
|
|
|
|
```bash
|
|
obsidian open file=Recipe
|
|
obsidian open path="Inbox/Idea.md" newtab
|
|
obsidian read
|
|
obsidian read file=Recipe
|
|
```
|
|
|
|
Search:
|
|
|
|
```bash
|
|
obsidian search query="TODO" matches
|
|
obsidian search query="status::active" format=json
|
|
obsidian search:open query="project notes"
|
|
```
|
|
|
|
Create/modify:
|
|
|
|
```bash
|
|
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"
|
|
```
|
|
|
|
Move/delete:
|
|
|
|
```bash
|
|
obsidian move file=Note to=Archive/
|
|
obsidian move path="Inbox/Old.md" to="Projects/New.md"
|
|
obsidian delete file=Note
|
|
```
|
|
|
|
Daily/tasks:
|
|
|
|
```bash
|
|
obsidian daily
|
|
obsidian daily:read
|
|
obsidian daily:append content="- [ ] Review inbox"
|
|
obsidian tasks all todo
|
|
obsidian task file=Note line=8 done
|
|
```
|
|
|
|
Properties/links:
|
|
|
|
```bash
|
|
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
|
|
```
|
|
|
|
Developer/debug:
|
|
|
|
```bash
|
|
obsidian plugin:reload my-plugin
|
|
obsidian dev:errors
|
|
obsidian dev:screenshot file=shot.png
|
|
obsidian eval "app.vault.getFiles().length"
|
|
```
|
|
|
|
## Notes
|
|
|
|
- `file=<name>` uses Obsidian-style file resolution; `path=<vault-relative.md>` is exact.
|
|
- Prefer CLI move/delete/property commands for Obsidian-aware updates.
|
|
- Prefer direct Markdown edits for bulk text changes after locating the vault path.
|
|
- Do not rely on third-party `obsidian-cli` unless user explicitly asks for it.
|