@magistr/obsidian-vault
v2026.03.28.2
Manage Obsidian vaults via the official CLI (v1.12+) — notes, search, tags, links, daily notes, properties
Labels
obsidiannotesknowledge-management
Contents
Quality score
How well-documented and verifiable this extension is.
Not yet scored.
A score will be generated the next time this extension is published. The owner can also trigger scoring manually.
Install
$ swamp extension pull @magistr/obsidian-vault@magistr/obsidian/vaultv2026.03.28.2obsidian_vault.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| vault | string | Obsidian vault name |
listList all notes in the vault
| Argument | Type | Description |
|---|---|---|
| folder? | string | Filter by folder path |
| ext? | string | Filter by extension (e.g. 'md') |
readRead a note's content
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note (e.g. 'folder/note.md') |
fileInfoShow file metadata (size, created, modified)
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
createCreate a new note
| Argument | Type | Description |
|---|---|---|
| name | string | Path for new note (e.g. 'folder/note.md' or 'note') |
| content? | string | Note content |
| template? | string | Template name to use |
| overwrite? | boolean | Overwrite if file exists |
appendAppend content to end of a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
| content | string | Content to append |
| inline? | boolean | Append without newline |
prependPrepend content after frontmatter
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
| content | string | Content to prepend |
| inline? | boolean | Prepend without newline |
deleteDelete a note (moves to trash by default)
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
| permanent? | boolean | Permanently delete instead of trash |
moveMove or rename a note (automatically rewrites wikilinks)
| Argument | Type | Description |
|---|---|---|
| file | string | Current path |
| to | string | Destination folder or path |
searchFull-text search with matching line context
| Argument | Type | Description |
|---|---|---|
| query | string | Search query |
| path? | string | Limit to folder |
| limit? | number | Max files to return |
tagsList all tags in the vault
| Argument | Type | Description |
|---|---|---|
| counts? | boolean | Include occurrence counts |
tagList files with a specific tag
| Argument | Type | Description |
|---|---|---|
| name | string | Tag name (e.g. '#swamp' or 'swamp') |
linksShow outgoing links from a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
backlinksShow files linking to a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
orphansList notes with no incoming links
unresolvedList unresolved/broken links in vault
| Argument | Type | Description |
|---|---|---|
| verbose? | boolean | Include source files |
dailyOpen or create today's daily note
dailyReadRead today's daily note content
dailyAppendAppend content to today's daily note
| Argument | Type | Description |
|---|---|---|
| content | string | Content to append |
| inline? | boolean | Append without newline |
dailyPrependPrepend content to today's daily note
| Argument | Type | Description |
|---|---|---|
| content | string | Content to prepend |
| inline? | boolean | Prepend without newline |
propertiesRead frontmatter properties of a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
propertySetSet a frontmatter property on a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
| name | string | Property name |
| value | string | Property value (use JSON array for list types, e.g. \ |
| type? | enum | Property type hint |
propertyRemoveRemove a frontmatter property from a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
| name | string | Property name to remove |
Resources
note(infinite)— Single note content and metadata
fileInfo(infinite)— File metadata (size, timestamps)
notes(infinite)— List of notes/files in vault
searchResults(infinite)— Search results with matching context
tags(infinite)— Tag listing
tagFiles(infinite)— Files matching a specific tag
links(infinite)— Links or backlinks for a note
unresolved(infinite)— Unresolved/broken links in vault
dailyNote(infinite)— Daily note content
properties(infinite)— Note frontmatter properties
operationResult(infinite)— Result of mutating operations