Obsidian Vault Fs
@mgreten/obsidian-vault-fsv2026.06.27.1
01README
Headless filesystem-first Obsidian vault model for Swamp automation. Reads, writes, appends, searches, lists, stats, and edits scalar frontmatter against a mounted vault without relying on the desktop Obsidian CLI.
02Models
@mgreten/obsidian-vault-fsv2026.06.27.1model.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| vaultRoot | string | |
| defaultFileMode | number | |
| defaultDirectoryMode | number | |
| blockDotObsidian | boolean |
fn read(file: string, allowDotObsidian: boolean)
Read a vault-relative or in-vault absolute markdown file.
| Argument | Type | Description |
|---|---|---|
| file | string | |
| allowDotObsidian | boolean |
fn write(file: string, content: string, overwrite: boolean, allowDotObsidian: boolean)
Create or overwrite a vault file with explicit overwrite protection.
| Argument | Type | Description |
|---|---|---|
| file | string | |
| content | string | |
| overwrite | boolean | |
| allowDotObsidian | boolean |
fn append(file: string, content: string, separator: string, allowDotObsidian: boolean)
Append markdown text to a vault file, creating it if needed.
| Argument | Type | Description |
|---|---|---|
| file | string | |
| content | string | |
| separator | string | |
| allowDotObsidian | boolean |
fn stat(file: string, allowDotObsidian: boolean)
Return filesystem metadata for a vault path.
| Argument | Type | Description |
|---|---|---|
| file | string | |
| allowDotObsidian | boolean |
fn list(folder: string, recursive: boolean, ext: string, limit: number, allowDotObsidian: boolean)
List files under a vault folder, optionally recursively and by extension.
| Argument | Type | Description |
|---|---|---|
| folder | string | |
| recursive | boolean | |
| ext | string | |
| limit | number | |
| allowDotObsidian | boolean |
fn search(query: string, folder: string, regex: boolean, caseSensitive: boolean, limit: number, allowDotObsidian: boolean)
Search markdown files under a vault folder.
| Argument | Type | Description |
|---|---|---|
| query | string | |
| folder | string | |
| regex | boolean | |
| caseSensitive | boolean | |
| limit | number | |
| allowDotObsidian | boolean |
fn properties(file: string, allowDotObsidian: boolean)
Read YAML frontmatter scalar properties from a markdown file.
| Argument | Type | Description |
|---|---|---|
| file | string | |
| allowDotObsidian | boolean |
fn setProperties(file: string, allowDotObsidian: boolean)
Merge scalar YAML frontmatter properties into a markdown file.
| Argument | Type | Description |
|---|---|---|
| file | string | |
| allowDotObsidian | boolean |
Resources
note(infinite)— Read Obsidian note content
writeResult(infinite)— Result of a write/append/frontmatter update
fileInfo(infinite)— Filesystem metadata for one vault path
fileList(infinite)— Listed vault files
searchResults(infinite)— Full-text search matches across markdown files
properties(infinite)— Parsed or updated note frontmatter properties
03Previous Versions
2026.06.09.1Jun 9, 2026
04Stats
A
100 / 100
Downloads
4
Archive size
13.0 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms