@e9n/pi-vault
Obsidian vault tool and health dashboard for pi
Package details
Install @e9n/pi-vault from npm and Pi will load the resources declared by the package manifest.
$ pi install npm:@e9n/pi-vault- Package
@e9n/pi-vault- Version
0.1.0- Published
- Feb 17, 2026
- Downloads
- 37/mo · 9/wk
- Author
- e9n
- License
- MIT
- Types
- extension
- Size
- 74.9 KB
- Dependencies
- 0 dependencies · 3 peers
Pi manifest JSON
{
"extensions": [
"./src/index.ts"
]
}Security note
Pi packages can execute code and influence agent behavior. Review the source before installing third-party packages.
README
@e9n/pi-vault
Obsidian vault integration for pi — read, write, search, and manage notes with a 16-action tool and a web health dashboard.
Features
obsidiantool — read, write, append, patch, search, daily notes, templates, frontmatter, and more- API-first with filesystem fallback — uses the Obsidian Local REST API when running, falls back to the filesystem otherwise
- Web dashboard at
/vault— daily note streak, project health, task breakdown, tag usage, recent activity - Deep links — click notes and tags to open directly in Obsidian
Settings
Add to ~/.pi/agent/settings.json or .pi/settings.json:
{
"pi-vault": {
"vaultPath": "~/Library/CloudStorage/.../Obsidian/MyVault",
"vaultName": "MyVault",
"apiUrl": "http://127.0.0.1:27123"
}
}
Set the API key as an environment variable:
export OBSIDIAN_API_KEY="your-api-key-here"
| Setting | Required | Default | Description |
|---|---|---|---|
vaultPath |
Yes | — | Path to vault root (~ expansion supported) |
vaultName |
No | basename of vaultPath |
Vault name for obsidian:// deep links |
apiUrl |
No | http://127.0.0.1:27123 |
Obsidian Local REST API URL |
OBSIDIAN_API_KEY (env) |
Yes (for API) | — | API key for Obsidian Local REST API plugin |
Tool: obsidian
| Action | API Required | Description |
|---|---|---|
read |
No | Read a note by path |
write |
No | Create or overwrite a note |
append |
No | Append content to a note |
patch |
Partial | Insert at heading, block ref, or frontmatter field |
delete |
No | Delete a note |
search |
No | Full-text search (grep fallback without API) |
dataview |
Yes | Run a Dataview DQL query |
search_jsonlogic |
Yes | JsonLogic structured search |
list |
No | Directory listing |
create_from_template |
No | Create a note from a vault template |
frontmatter |
No | Read or update YAML frontmatter |
recent |
No | List recently modified notes |
daily |
No | Read or create a daily note |
open |
Yes | Open a file in the Obsidian UI |
commands |
Yes | List or execute Obsidian commands |
document_map |
No | List headings, block refs, and frontmatter fields |
Web UI
Start the web server with /web, then open http://localhost:4100/vault. Requires pi-webserver.
Install
pi install npm:@e9n/pi-vault
License
MIT