Skip to content

Open the active file in your IDE (supports all file types including .base, .canvas, and more)."

License

Notifications You must be signed in to change notification settings

carlstedt1/open-in-ide

Repository files navigation

Open in IDE

Open the current Obsidian file in your IDE of choice. Supports all file types in your vault (.md, .base, .canvas, and more). Version 1.0.0 extends support beyond markdown files, with Cursor support that reuses existing windows when possible and stages the vault before jumping to the file.

Current version: 1.0.0

✨ Features

  • Command palette action + optional hotkey
  • Reuse an existing Cursor window (or spawn a new one)
  • Jump to the active file and cursor position (supports all file types)
  • Settings for CLI path, vault staging, reuse behaviour, and OS fallbacks

✅ Currently supported IDEs

IDE Status Notes
Cursor ✅ Supported macOS tested, CLI required
VSCode ❌ Not supported yet Coming soon
Next up: Neovim, JetBrains, and more.

🧩 Requirements

  • Desktop Obsidian (relies on FileSystemAdapter)
  • Cursor CLI on your PATH
    • Install within Cursor via Cmd+Shift+PShell Command: Install "cursor"
    • macOS Homebrew: brew install --cask cursor
    • Windows: ensure Cursor is installed and restart the terminal so %LocalAppData%\Programs\cursor\bin is on PATH.
  • Tested on macOS; other platforms have not yet been formally certified

🚀 Installation

  1. Open SettingsCommunity plugins in Obsidian.
  2. Search for Open in IDE.
  3. Click Install and then Enable.

Alternatively, for manual installation:

  1. Copy main.js and manifest.json into Vault/.obsidian/plugins/open-in-ide/.
  2. Reload Obsidian and enable the plugin.

🧭 Usage

  1. Open any file in your vault (markdown, .base, .canvas, etc.)
  2. Run Open in IDE (Cursor) from the command palette or your hotkey
  3. Cursor reuses or opens a window, stages the vault (if enabled), and focuses the file
  4. For text files with an active editor, the cursor position is preserved

⚙️ Settings

Setting Description
Cursor executable path Override the Cursor binary location
Reuse existing window Prefer existing Cursor windows for the vault
Open vault before file Ensure the vault is loaded into Cursor before the note
Allow system fallback Use open / start / xdg-open if the CLI cannot be found

🪲 Troubleshooting

  • "Cursor executable not found …" → update the path or install the CLI
  • "Unable to resolve absolute path …" → only files inside the vault are supported
  • OS fallback notices mean the command fell back to system launchers instead of the CLI

🚧 Known limitations

  • Desktop-only; mobile lacks the required APIs
  • Cursor CLI is strongly recommended—fallback launchers are best-effort
  • Only supports files inside the vault
  • Window reuse ultimately depends on the Cursor CLI
  • Cursor position is only preserved for files with an active text editor

See CHANGELOG.md for release history and AGENTS.md for developer notes.

About

Open the active file in your IDE (supports all file types including .base, .canvas, and more)."

Resources

License

Stars

Watchers

Forks

Packages

No packages published