README file from
GithubWisdio Companion
Wisdio Companion connects your Obsidian vault with the Wisdio browser extension.
Wisdio Companion is purpose-built for Wisdio's Obsidian Link workflow. It is not a general-purpose REST API for Obsidian.
It runs a private local companion service on your computer so Wisdio can create, read, update, and live-sync Markdown notes in your vault. Your notes remain local Markdown files, and the companion service binds to 127.0.0.1 only.
Requirements
- Obsidian 1.0.0 or newer
- Desktop Obsidian only
- Wisdio browser extension
What it does
- Creates Wisdio notes as Markdown files in your vault
- Syncs Wisdio note edits into Obsidian
- Sends vault file events back to Wisdio for live refresh
- Lets you choose the Wisdio notes folder
- Provides a customizable Markdown template for new Wisdio notes
- Uses a local API key so only authorized local clients can connect
Setup
- Install and enable Wisdio Companion in Obsidian.
- Open Settings -> Wisdio Companion.
- Copy the generated API Key.
- Open the Wisdio browser extension settings.
- Enable Obsidian Link.
- Use the default endpoint unless you changed the port:
http://127.0.0.1:27125
- Paste the API key from Obsidian into Wisdio.
- Choose the vault folder where Wisdio notes should be stored, for example:
Wisdio
Settings
- Enabled: Starts or stops the local API and WebSocket server.
- Port: Local loopback port. Default is
27125. - API Key: Bearer token used by the Wisdio browser extension.
- Folder: Vault folder used for Wisdio notes and event filtering.
- Template File: Vault-relative Markdown template for new Wisdio notes.
- Reset Template File: Restores the default Wisdio note template.
Template variables
The default template is stored at:
Wisdio/Templates/Default Note.md
You can edit it directly in Obsidian. Supported variables:
{{id}}{{title}}{{content}}{{sourceUrl}}{{url}}{{createdAt}}{{updatedAt}}
Privacy and security
- Wisdio Companion only binds to
127.0.0.1. - It does not expose your vault to the public internet.
- Requests require the API key shown in plugin settings.
- Wisdio note files are ordinary Markdown files in your local vault.
- Deleting files is intentionally not exposed through the local API. Delete real files from Obsidian.
Manual install for reviewers
If the Wisdio browser extension is not yet available in the Chrome Web Store, you can still test the connection by installing the extension package manually from the Wisdio release build.
For local development:
npm install
npm run build
Then copy main.js and manifest.json into:
<your vault>/.obsidian/plugins/wisdio-companion/
Enable Wisdio Companion from Obsidian community plugin settings.
Support
Please open an issue in this repository for bugs, setup questions, or compatibility problems.