Official Obsidian CLI (v1.12+). Complete command-line interface for Obsidian notes, tasks, search, tags, properties, links, and more.
Official command-line interface for Obsidian (v1.12+). 115 commands.
Add Obsidian to PATH:
macOS:
export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"
Windows:
$env:PATH += ";$env:LOCALAPPDATA\Obsidian"
Linux:
alias obsidian='flatpak run md.obsidian.Obsidian'~/.local/bin and chmod +xTest: obsidian version
name=value or name="value with spaces"open, overwrite\n in content stringsobsidian vault="My Vault" <command> (must be first)file=<name> (wikilink-style) or path=<folder/file.md> (exact)--copy to any commandobsidian daily # Open today
obsidian daily:append content="- [ ] Buy milk" # Add to today
obsidian daily:prepend content="# Important" # Add to top
obsidian daily:read # Read today's content
obsidian daily:path # Get daily note path
obsidian create name="Note" content="# Hello" # Create note
obsidian create name="Note" template=Meeting # Create from template
obsidian read file="Note" # Read note
obsidian append file="Note" content="More text" # Append to note
obsidian prepend file="Note" content="Top text" # Prepend to note
obsidian move file="Note" to="Archive/Note.md" # Move note
obsidian rename file="Note" name="New Name" # Rename note
obsidian delete file="Note" # Delete note
obsidian open file="Note" # Open note
obsidian search query="meeting notes" # Search vault
obsidian search:context query="TODO" # Search with context
obsidian search:open query="project" # Open search view
obsidian tasks daily todo # Incomplete tasks in daily
obsidian tasks todo # All incomplete tasks
obsidian task daily line=3 toggle # Toggle task at line 3
obsidian tags counts # List all tags
obsidian tags counts sort=count # Sort by frequency
obsidian property:set name="status" value="done" file="Note"
obsidian property:read name="status" file="Note"
obsidian property:remove name="status" file="Note"
obsidian properties file="Note" # List all properties
obsidian backlinks file="Note" # Incoming links
obsidian links file="Note" # Outgoing links
obsidian orphans # No incoming links
obsidian deadends # No outgoing links
obsidian unresolved # Broken links
obsidian devtools # Open dev tools
obsidian eval code="app.vault.getFiles().length" # Run JavaScript
obsidian dev:screenshot path=screenshot.png # Screenshot
obsidian plugin:reload id=my-plugin # Reload plugin
help - Show help / help for specific commandversion - Show Obsidian versionreload - Reload the app windowrestart - Restart the appdaily - Open daily notedaily:path - Get daily note pathdaily:read - Read daily note contentsdaily:append - Append content to daily notedaily:prepend - Prepend content to daily notefile - Show file infofiles - List files in vaultfolder - Show folder infofolders - List folders in vaultopen - Open a filecreate - Create a new fileread - Read file contentsappend - Append content to a fileprepend - Prepend content to a filemove - Move or rename a filerename - Rename a filedelete - Delete a filesearch - Search vault for textsearch:context - Search with matching line contextsearch:open - Open search viewtasks - List tasks in the vaulttask - Show or update a tasktags - List tags in the vaulttag - Get tag infoproperties - List properties in the vaultproperty:set - Set a property on a fileproperty:remove - Remove a property from a fileproperty:read - Read a property valuealiases - List aliases in the vaultbacklinks - List backlinks to a filelinks - List outgoing links from a fileunresolved - List unresolved linksorphans - Files with no incoming linksdeadends - Files with no outgoing linksoutline - Show headings for a filebookmarks - List bookmarksbookmark - Add a bookmarkbases - List all base filesbase:views - List views in a basebase:create - Create a new item in a basebase:query - Query a base and return resultstemplates - List templatestemplate:read - Read template contenttemplate:insert - Insert template into active filecommands - List available command IDscommand - Execute an Obsidian commandhotkeys - List hotkeyshotkey - Get hotkey for a commandtabs - List open tabstab:open - Open a new tabworkspace - Show workspace treeworkspaces - List saved workspacesworkspace:load - Load a saved workspaceworkspace:save - Save current layoutworkspace:delete - Delete a saved workspacediff - List or diff local/sync versionshistory - List file history versionshistory:list - List files with historyhistory:read - Read a file history versionhistory:restore - Restore a file history versionhistory:open - Open file recoverysync - Pause or resume sync (on/off)sync:status - Show sync statussync:history - List sync version historysync:read - Read a sync versionsync:restore - Restore a sync versionsync:open - Open sync historysync:deleted - List deleted files in syncpublish:site - Show publish site infopublish:list - List published filespublish:status - Show publish statuspublish:add - Publish filespublish:remove - Unpublish filespublish:open - Open published sitethemes - List installed themestheme - Show active theme or get infotheme:set - Set active themetheme:install - Install a community themetheme:uninstall - Uninstall a themesnippets - List installed CSS snippetssnippets:enabled - List enabled CSS snippetssnippet:enable - Enable a CSS snippetsnippet:disable - Disable a CSS snippetplugins - List installed pluginsplugins:enabled - List enabled pluginsplugins:restrict - Toggle restricted modeplugin - Get plugin infoplugin:enable - Enable a pluginplugin:disable - Disable a pluginplugin:install - Install a community pluginplugin:uninstall - Uninstall a community pluginplugin:reload - Reload a pluginvault - Show vault infovaults - List known vaultsvault:open - Open a vault (TUI only)random - Open a random noterandom:read - Read a random noteunique - Create unique noteweb - Open URL in web viewerwordcount - Count words and charactersrecents - List recently opened filesdevtools - Toggle Electron dev toolseval - Execute JavaScriptdev:screenshot - Take a screenshotdev:console - Show captured console messagesdev:errors - Show captured errorsdev:css - Inspect CSS with source locationsdev:dom - Query DOM elementsdev:cdp - Run Chrome DevTools Protocol commanddev:debug - Attach/detach CDP debuggerdev:mobile - Toggle mobile emulation"Cannot connect to Obsidian"
"Command not found: obsidian"
"File not found"
file=Name resolves like wikilinks (no path, no .md)path=folder/file.md for exact pathsobsidian daily # 打开今日日记
obsidian create name="笔记" # 创建笔记
obsidian search query="关键词" # 搜索
obsidian tasks daily todo # 列出未完成任务
obsidian tags counts # 列出标签