README file from
GithubOpen in Zed
Open the current vault, folder, or note in Zed.
Features
- Ribbon button: Opens the vault root
- Command palette: Opens the vault root
- File/folder menu:
- Opens a selected file or folder
- For the active note, it jumps to the cursor's line and column
Requirements
- Install the Zed CLI: In Zed click the Zed menu > Install CLI
- Check the absolute path to
zedbinary is correct in the plugin settings
Common paths for zed binary:
/usr/local/bin/zed: default macOS install location/opt/homebrew/bin/zed: Apple Silicon Homebrew~/.local/bin/zedor/usr/bin/zed: Linux
Installation
Manual
Manual-only until this PR is merged: https://github.com/obsidianmd/obsidian-releases/pull/12600
- Build:
npm install && npm run build - Copy
target/into<your-vault>/.obsidian/plugins/open-in-zed/ - Enable
Open in Zedin Obsidian's Community Plugins settings - Confirm the
zedbinary path in the plugin settings
Community plugins
Once published in Obsidian's community plugin directory:
- Open Obsidian Settings, Community plugins
- Browse for
Open in Zed - Install and enable the plugin
- Confirm the
zedbinary path in the plugin settings
Development
npm install
npm run dev # esbuild watch mode, rebuilds into target/
npm run check # type-check + lint + format
npm run build # production build into target/
Tip: For fast local testing:
- Create a
.devtargetfile containing the absolute path to a test vault plugin folder - Each build syncs
target/*there
Release prep
npm run bump-version -- <version>`
This will update:
package.jsonmanifest.jsonversions.json
License
MIT.