Obsidian URI Scheme Reference

Obsidian registers the obsidian:// protocol for deep linking and automation.

tools-only Updated Sep 29, 2026 7 repo stars

Coding & Dev Tools

Install

Press C to copy

$ npx skillmds@latest add tools-only/obsidian-uri-scheme-reference

Installs into ~/.claude/skills (or .claude/skills inside a project). Restart Claude Code to pick it up.

＋ Add to plugin

README badge

[![SkillMD](https://skillmd.com/badge/tools-only/obsidian-uri-scheme-reference.svg)](https://skillmd.com/skills/tools-only/obsidian-uri-scheme-reference)

Trust & safety

1 of 3 audits passed

Last audited Sep 23, 2026 · commit b9efde1

Works with: Claude Code Claude.ai OpenAI Codex +

File contents

Obsidian URI Scheme Reference

Complete reference for Obsidian's URI automation capabilities.

Native URI Scheme

Obsidian registers the obsidian:// protocol for deep linking and automation.

Basic Format

obsidian://action?param1=value1&param2=value2

Actions

open

Opens a vault or file.

# Open vault
obsidian://open?vault=MyVault

# Open file (without .md extension)
obsidian://open?vault=MyVault&file=Notes/MyNote

# Open file with full path
obsidian://open?vault=MyVault&path=Notes/SubFolder/MyNote.md

# Open and navigate to line
obsidian://open?vault=MyVault&file=MyNote&line=10

Parameter	Required	Description
`vault`	Yes	Vault name
`file`	No	File path without extension
`path`	No	Full file path with extension
`line`	No	Line number to navigate to

new

Creates a new note.

# Create note with name
obsidian://new?vault=MyVault&name=NewNote

# Create with content
obsidian://new?vault=MyVault&name=NewNote&content=Hello%20World

# Create in folder
obsidian://new?vault=MyVault&name=Folder/NewNote

# Create with template
obsidian://new?vault=MyVault&name=NewNote&template=Templates/MyTemplate

# Overwrite if exists
obsidian://new?vault=MyVault&name=NewNote&overwrite=true

# Append to existing
obsidian://new?vault=MyVault&name=NewNote&append=true

Parameter	Required	Description
`vault`	Yes	Vault name
`name`	Yes	Note name (can include path)
`content`	No	URL-encoded content
`template`	No	Template file path
`overwrite`	No	Replace existing file
`append`	No	Append to existing file
`silent`	No	Don't open the note

search

Opens the search panel with a query.

# Simple search
obsidian://search?vault=MyVault&query=keyword

# Search with operators
obsidian://search?vault=MyVault&query=tag:%23important

# File search
obsidian://search?vault=MyVault&query=file:readme

Parameter	Required	Description
`vault`	Yes	Vault name
`query`	Yes	URL-encoded search query

Advanced URI Plugin

The Advanced URI plugin extends native URIs with more capabilities.

Installation

Install "Advanced URI" from Community Plugins
Enable the plugin

Advanced URI Format

obsidian://adv-uri?param1=value1&param2=value2

File Identification

# By file path
obsidian://adv-uri?vault=MyVault&filepath=Notes/MyNote.md

# By file UID (requires UID plugin)
obsidian://adv-uri?vault=MyVault&uid=abc123

# By daily note
obsidian://adv-uri?vault=MyVault&daily=true

# By periodic note
obsidian://adv-uri?vault=MyVault&periodic=weekly

Content Operations

# Write content (replace)
obsidian://adv-uri?vault=MyVault&filepath=Note.md&data=New%20Content&mode=overwrite

# Append content
obsidian://adv-uri?vault=MyVault&filepath=Note.md&data=Appended%20text&mode=append

# Prepend content
obsidian://adv-uri?vault=MyVault&filepath=Note.md&data=Prepended%20text&mode=prepend

# Insert from clipboard
obsidian://adv-uri?vault=MyVault&filepath=Note.md&clipboard=true&mode=append

# Insert at heading
obsidian://adv-uri?vault=MyVault&filepath=Note.md&heading=Section&data=Content&mode=append

# Insert at block
obsidian://adv-uri?vault=MyVault&filepath=Note.md&block=block-id&data=Content&mode=append

Parameter	Description
`data`	URL-encoded content to write
`mode`	overwrite, append, prepend, new
`clipboard`	Use clipboard content
`heading`	Target heading
`block`	Target block ID

Navigation

# Go to heading
obsidian://adv-uri?vault=MyVault&filepath=Note.md&heading=MyHeading

# Go to block
obsidian://adv-uri?vault=MyVault&filepath=Note.md&block=block-id

# Go to line
obsidian://adv-uri?vault=MyVault&filepath=Note.md&line=50

# Open in new pane
obsidian://adv-uri?vault=MyVault&filepath=Note.md&newpane=true

# Open in reading view
obsidian://adv-uri?vault=MyVault&filepath=Note.md&viewmode=preview

# Open in editing view
obsidian://adv-uri?vault=MyVault&filepath=Note.md&viewmode=source

Command Execution

# Execute command by ID
obsidian://adv-uri?vault=MyVault&commandid=app:open-settings

# Execute with file context
obsidian://adv-uri?vault=MyVault&filepath=Note.md&commandid=workspace:export-pdf

# Common command IDs:
# app:open-settings
# app:open-help
# editor:toggle-fold
# workspace:export-pdf
# workspace:split-vertical
# workspace:split-horizontal

Workspace Operations

# Load workspace layout
obsidian://adv-uri?vault=MyVault&workspace=MyWorkspace

# Save current workspace
obsidian://adv-uri?vault=MyVault&saveworkspace=MyWorkspace

Frontmatter Manipulation

# Update frontmatter field
obsidian://adv-uri?vault=MyVault&filepath=Note.md&frontmatterkey=status&frontmattervalue=done

# Multiple fields (JSON)
obsidian://adv-uri?vault=MyVault&filepath=Note.md&updatepluginid=adv-uri&updatekeys=status,priority&updatevalues=done,high

Search and Replace

# Search and replace in file
obsidian://adv-uri?vault=MyVault&filepath=Note.md&search=old%20text&replace=new%20text

# Regex search
obsidian://adv-uri?vault=MyVault&filepath=Note.md&searchregex=%5Cbold%5Cb&replace=new

Advanced Parameters

Parameter	Description
`newpane`	Open in new pane (true/false)
`viewmode`	source, preview, live
`openmode`	tab, split, window, hover
`focus`	Focus after opening (true/false)
`line`	Jump to line number
`column`	Jump to column
`settingid`	Open specific settings tab
`eval`	Execute JavaScript (requires explicit enable)
`x-success`	Callback URL on success
`x-error`	Callback URL on error

Actions URI Plugin

Adds x-callback-url support with standardized actions.

Format

obsidian://actions-uri/action/subaction?params

Note Actions

# Get note content
obsidian://actions-uri/note/get?vault=MyVault&file=Note.md&x-success=callback://

# Create note
obsidian://actions-uri/note/create?vault=MyVault&file=Note.md&content=Hello

# Append to note
obsidian://actions-uri/note/append?vault=MyVault&file=Note.md&content=Appended

# Prepend to note
obsidian://actions-uri/note/prepend?vault=MyVault&file=Note.md&content=Prepended

# Search and replace
obsidian://actions-uri/note/search-replace?vault=MyVault&file=Note.md&search=old&replace=new

Daily Note Actions

# Get today's note
obsidian://actions-uri/daily-note/get-current?vault=MyVault&x-success=callback://

# Get specific date
obsidian://actions-uri/daily-note/get?vault=MyVault&date=2024-01-15

# Append to daily note
obsidian://actions-uri/daily-note/append?vault=MyVault&content=Added%20item

Navigation Actions

# Open file
obsidian://actions-uri/open?vault=MyVault&file=Note.md

# Open in new tab
obsidian://actions-uri/open/new-tab?vault=MyVault&file=Note.md

# Open in split
obsidian://actions-uri/open/split?vault=MyVault&file=Note.md

URL Encoding

Special characters must be URL-encoded:

Character	Encoded
Space	`%20` or `+`
`/`	`%2F`
`#`	`%23`
`&`	`%26`
`=`	`%3D`
`?`	`%3F`
`%`	`%25`
`[`	`%5B`
`]`	`%5D`
`\|`	`%7C`
Newline	`%0A`

Encoding Examples

# File with spaces
obsidian://open?vault=My%20Vault&file=My%20Note

# Content with newlines
obsidian://new?vault=MyVault&name=Note&content=Line%201%0ALine%202

# Heading with special chars
obsidian://adv-uri?vault=MyVault&filepath=Note.md&heading=Section%20%231

Shell Integration

macOS

# Open URI
open "obsidian://open?vault=MyVault"

# From AppleScript
osascript -e 'open location "obsidian://open?vault=MyVault"'

Linux

# Open URI
xdg-open "obsidian://open?vault=MyVault"

# Or with gio
gio open "obsidian://open?vault=MyVault"

Windows

# Open URI
Start-Process "obsidian://open?vault=MyVault"

# Or via cmd
start "" "obsidian://open?vault=MyVault"

Integration Examples

Alfred Workflow

# Create quick capture note
obsidian://new?vault=MyVault&name=Inbox/{date}&content={query}&append=true

iOS Shortcuts

URL: obsidian://adv-uri?vault=MyVault&daily=true&data=[Shortcut Input]&mode=append

Raycast Extension

# Open daily note
obsidian://adv-uri?vault=MyVault&daily=true

Keyboard Maestro

do shell script "open 'obsidian://adv-uri?vault=MyVault&daily=true&clipboard=true&mode=append'"

Common Use Cases

Quick Capture

# Append clipboard to inbox
obsidian://adv-uri?vault=MyVault&filepath=Inbox.md&clipboard=true&mode=append

Daily Journal Entry

# Add timestamped entry to daily note
obsidian://adv-uri?vault=MyVault&daily=true&data=%0A##%20$(date +%H:%M)%0A{input}&mode=append

Project Quick Access

# Open project note and split with tasks
obsidian://adv-uri?vault=Work&filepath=Projects/CurrentProject.md&commandid=workspace:split-vertical

Meeting Notes

# Create meeting note from template
obsidian://new?vault=Work&name=Meetings/$(date +%Y-%m-%d)-Meeting&template=Templates/Meeting

---name: obsidian-uri-scheme-referencedescription: Obsidian registers the obsidian:// protocol for deep linking and automation.---# Obsidian URI Scheme ReferenceComplete reference for Obsidian's URI automation capabilities.## Native URI SchemeObsidian registers the `obsidian://` protocol for deep linking and automation.### Basic Format```textobsidian://action?param1=value1&param2=value2```### Actions#### openOpens a vault or file.```bash# Open vaultobsidian://open?vault=MyVault# Open file (without .md extension)obsidian://open?vault=MyVault&file=Notes/MyNote# Open file with full pathobsidian://open?vault=MyVault&path=Notes/SubFolder/MyNote.md# Open and navigate to lineobsidian://open?vault=MyVault&file=MyNote&line=10```| Parameter | Required | Description ||-----------|----------|-------------|| `vault` | Yes | Vault name || `file` | No | File path without extension || `path` | No | Full file path with extension || `line` | No | Line number to navigate to |#### newCreates a new note.```bash# Create note with nameobsidian://new?vault=MyVault&name=NewNote# Create with contentobsidian://new?vault=MyVault&name=NewNote&content=Hello%20World# Create in folderobsidian://new?vault=MyVault&name=Folder/NewNote# Create with templateobsidian://new?vault=MyVault&name=NewNote&template=Templates/MyTemplate# Overwrite if existsobsidian://new?vault=MyVault&name=NewNote&overwrite=true# Append to existingobsidian://new?vault=MyVault&name=NewNote&append=true```| Parameter | Required | Description ||-----------|----------|-------------|| `vault` | Yes | Vault name || `name` | Yes | Note name (can include path) || `content` | No | URL-encoded content || `template` | No | Template file path || `overwrite` | No | Replace existing file || `append` | No | Append to existing file || `silent` | No | Don't open the note |#### searchOpens the search panel with a query.```bash# Simple searchobsidian://search?vault=MyVault&query=keyword# Search with operatorsobsidian://search?vault=MyVault&query=tag:%23important# File searchobsidian://search?vault=MyVault&query=file:readme```| Parameter | Required | Description ||-----------|----------|-------------|| `vault` | Yes | Vault name || `query` | Yes | URL-encoded search query |## Advanced URI PluginThe Advanced URI plugin extends native URIs with more capabilities.### Installation1. Install "Advanced URI" from Community Plugins2. Enable the plugin### Advanced URI Format```textobsidian://adv-uri?param1=value1&param2=value2```### File Identification```bash# By file pathobsidian://adv-uri?vault=MyVault&filepath=Notes/MyNote.md# By file UID (requires UID plugin)obsidian://adv-uri?vault=MyVault&uid=abc123# By daily noteobsidian://adv-uri?vault=MyVault&daily=true# By periodic noteobsidian://adv-uri?vault=MyVault&periodic=weekly```### Content Operations```bash# Write content (replace)obsidian://adv-uri?vault=MyVault&filepath=Note.md&data=New%20Content&mode=overwrite# Append contentobsidian://adv-uri?vault=MyVault&filepath=Note.md&data=Appended%20text&mode=append# Prepend contentobsidian://adv-uri?vault=MyVault&filepath=Note.md&data=Prepended%20text&mode=prepend# Insert from clipboardobsidian://adv-uri?vault=MyVault&filepath=Note.md&clipboard=true&mode=append# Insert at headingobsidian://adv-uri?vault=MyVault&filepath=Note.md&heading=Section&data=Content&mode=append# Insert at blockobsidian://adv-uri?vault=MyVault&filepath=Note.md&block=block-id&data=Content&mode=append```| Parameter | Description ||-----------|-------------|| `data` | URL-encoded content to write || `mode` | overwrite, append, prepend, new || `clipboard` | Use clipboard content || `heading` | Target heading || `block` | Target block ID |### Navigation```bash# Go to headingobsidian://adv-uri?vault=MyVault&filepath=Note.md&heading=MyHeading# Go to blockobsidian://adv-uri?vault=MyVault&filepath=Note.md&block=block-id# Go to lineobsidian://adv-uri?vault=MyVault&filepath=Note.md&line=50# Open in new paneobsidian://adv-uri?vault=MyVault&filepath=Note.md&newpane=true# Open in reading viewobsidian://adv-uri?vault=MyVault&filepath=Note.md&viewmode=preview# Open in editing viewobsidian://adv-uri?vault=MyVault&filepath=Note.md&viewmode=source```### Command Execution```bash# Execute command by IDobsidian://adv-uri?vault=MyVault&commandid=app:open-settings# Execute with file contextobsidian://adv-uri?vault=MyVault&filepath=Note.md&commandid=workspace:export-pdf# Common command IDs:# app:open-settings# app:open-help# editor:toggle-fold# workspace:export-pdf# workspace:split-vertical# workspace:split-horizontal```### Workspace Operations```bash# Load workspace layoutobsidian://adv-uri?vault=MyVault&workspace=MyWorkspace# Save current workspaceobsidian://adv-uri?vault=MyVault&saveworkspace=MyWorkspace```### Frontmatter Manipulation```bash# Update frontmatter fieldobsidian://adv-uri?vault=MyVault&filepath=Note.md&frontmatterkey=status&frontmattervalue=done# Multiple fields (JSON)obsidian://adv-uri?vault=MyVault&filepath=Note.md&updatepluginid=adv-uri&updatekeys=status,priority&updatevalues=done,high```### Search and Replace```bash# Search and replace in fileobsidian://adv-uri?vault=MyVault&filepath=Note.md&search=old%20text&replace=new%20text# Regex searchobsidian://adv-uri?vault=MyVault&filepath=Note.md&searchregex=%5Cbold%5Cb&replace=new```### Advanced Parameters| Parameter | Description ||-----------|-------------|| `newpane` | Open in new pane (true/false) || `viewmode` | source, preview, live || `openmode` | tab, split, window, hover || `focus` | Focus after opening (true/false) || `line` | Jump to line number || `column` | Jump to column || `settingid` | Open specific settings tab || `eval` | Execute JavaScript (requires explicit enable) || `x-success` | Callback URL on success || `x-error` | Callback URL on error |## Actions URI PluginAdds x-callback-url support with standardized actions.### Format```textobsidian://actions-uri/action/subaction?params```### Note Actions```bash# Get note contentobsidian://actions-uri/note/get?vault=MyVault&file=Note.md&x-success=callback://# Create noteobsidian://actions-uri/note/create?vault=MyVault&file=Note.md&content=Hello# Append to noteobsidian://actions-uri/note/append?vault=MyVault&file=Note.md&content=Appended# Prepend to noteobsidian://actions-uri/note/prepend?vault=MyVault&file=Note.md&content=Prepended# Search and replaceobsidian://actions-uri/note/search-replace?vault=MyVault&file=Note.md&search=old&replace=new```### Daily Note Actions```bash# Get today's noteobsidian://actions-uri/daily-note/get-current?vault=MyVault&x-success=callback://# Get specific dateobsidian://actions-uri/daily-note/get?vault=MyVault&date=2024-01-15# Append to daily noteobsidian://actions-uri/daily-note/append?vault=MyVault&content=Added%20item```### Navigation Actions```bash# Open fileobsidian://actions-uri/open?vault=MyVault&file=Note.md# Open in new tabobsidian://actions-uri/open/new-tab?vault=MyVault&file=Note.md# Open in splitobsidian://actions-uri/open/split?vault=MyVault&file=Note.md```## URL EncodingSpecial characters must be URL-encoded:| Character | Encoded ||-----------|---------|| Space | `%20` or `+` || `/` | `%2F` || `#` | `%23` || `&` | `%26` || `=` | `%3D` || `?` | `%3F` || `%` | `%25` || `[` | `%5B` || `]` | `%5D` || `\|` | `%7C` || Newline | `%0A` |### Encoding Examples```bash# File with spacesobsidian://open?vault=My%20Vault&file=My%20Note# Content with newlinesobsidian://new?vault=MyVault&name=Note&content=Line%201%0ALine%202# Heading with special charsobsidian://adv-uri?vault=MyVault&filepath=Note.md&heading=Section%20%231```## Shell Integration### macOS```bash# Open URIopen "obsidian://open?vault=MyVault"# From AppleScriptosascript -e 'open location "obsidian://open?vault=MyVault"'```### Linux```bash# Open URIxdg-open "obsidian://open?vault=MyVault"# Or with giogio open "obsidian://open?vault=MyVault"```### Windows```powershell# Open URIStart-Process "obsidian://open?vault=MyVault"# Or via cmdstart "" "obsidian://open?vault=MyVault"```## Integration Examples### Alfred Workflow```bash# Create quick capture noteobsidian://new?vault=MyVault&name=Inbox/{date}&content={query}&append=true```### iOS Shortcuts```textURL: obsidian://adv-uri?vault=MyVault&daily=true&data=[Shortcut Input]&mode=append```### Raycast Extension```bash# Open daily noteobsidian://adv-uri?vault=MyVault&daily=true```### Keyboard Maestro```applescriptdo shell script "open 'obsidian://adv-uri?vault=MyVault&daily=true&clipboard=true&mode=append'"```## Common Use Cases### Quick Capture```bash# Append clipboard to inboxobsidian://adv-uri?vault=MyVault&filepath=Inbox.md&clipboard=true&mode=append```### Daily Journal Entry```bash# Add timestamped entry to daily noteobsidian://adv-uri?vault=MyVault&daily=true&data=%0A##%20$(date +%H:%M)%0A{input}&mode=append```### Project Quick Access```bash# Open project note and split with tasksobsidian://adv-uri?vault=Work&filepath=Projects/CurrentProject.md&commandid=workspace:split-vertical```### Meeting Notes```bash# Create meeting note from templateobsidian://new?vault=Work&name=Meetings/$(date +%Y-%m-%d)-Meeting&template=Templates/Meeting```

tools-only/X-Skills/tree/main/daily-assistant/2355-uri-scheme_6818c637 commit b9efde114f

Frequently asked questions

npx skillmds@latest add tools-only/obsidian-uri-scheme-reference