Obsidian Vault
@magistr/obsidian-vaultv2026.05.25.1
01README
Manage Obsidian vaults via the official CLI (v1.12+) — notes, search, tags, links, daily notes, properties
02Release Notes
Merge pull request #4 from umag/extensions/magistr-grade-a-workspace
extensions: stage 15 @magistr extensions as Grade A workspace dirs + wire CI
03Models
@magistr/obsidian/vaultv2026.05.25.1obsidian_vault.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| vault | string | Obsidian vault name |
fn list(folder?: string, ext?: string)
List all notes in the vault
| Argument | Type | Description |
|---|---|---|
| folder? | string | Filter by folder path |
| ext? | string | Filter by extension (e.g. 'md') |
fn read(file: string)
Read a note's content
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note (e.g. 'folder/note.md') |
fn fileInfo(file: string)
Show file metadata (size, created, modified)
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
fn create(name: string, content?: string, template?: string, overwrite?: boolean)
Create 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 |
fn append(file: string, content: string, inline?: boolean)
Append content to end of a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
| content | string | Content to append |
| inline? | boolean | Append without newline |
fn prepend(file: string, content: string, inline?: boolean)
Prepend content after frontmatter
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
| content | string | Content to prepend |
| inline? | boolean | Prepend without newline |
fn delete(file: string, permanent?: boolean)
Delete a note (moves to trash by default)
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
| permanent? | boolean | Permanently delete instead of trash |
fn move(file: string, to: string)
Move or rename a note (automatically rewrites wikilinks)
| Argument | Type | Description |
|---|---|---|
| file | string | Current path |
| to | string | Destination folder or path |
fn search(query: string, path?: string, limit?: number)
Full-text search with matching line context
| Argument | Type | Description |
|---|---|---|
| query | string | Search query |
| path? | string | Limit to folder |
| limit? | number | Max files to return |
fn tags(counts?: boolean)
List all tags in the vault
| Argument | Type | Description |
|---|---|---|
| counts? | boolean | Include occurrence counts |
fn tag(name: string)
List files with a specific tag
| Argument | Type | Description |
|---|---|---|
| name | string | Tag name (e.g. '#swamp' or 'swamp') |
fn links(file: string)
Show outgoing links from a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
fn backlinks(file: string)
Show files linking to a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
fn orphans()
List notes with no incoming links
fn unresolved(verbose?: boolean)
List unresolved/broken links in vault
| Argument | Type | Description |
|---|---|---|
| verbose? | boolean | Include source files |
fn daily()
Open or create today's daily note
fn dailyRead()
Read today's daily note content
fn dailyAppend(content: string, inline?: boolean)
Append content to today's daily note
| Argument | Type | Description |
|---|---|---|
| content | string | Content to append |
| inline? | boolean | Append without newline |
fn dailyPrepend(content: string, inline?: boolean)
Prepend content to today's daily note
| Argument | Type | Description |
|---|---|---|
| content | string | Content to prepend |
| inline? | boolean | Prepend without newline |
fn properties(file: string)
Read frontmatter properties of a note
| Argument | Type | Description |
|---|---|---|
| file | string | Path to note |
fn propertySet(file: string, name: string, value: string, type?: enum)
Set 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 |
fn propertyRemove(file: string, name: string)
Remove 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
04Previous Versions
2026.03.28.2Mar 28, 2026
05Stats
A
100 / 100
Downloads
7
Archive size
11.9 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
Repository
https://github.com/umag/swamp-workspace06Platforms
07Labels