# Switch2Cursor

Open your vault or current note in [Cursor](https://cursor.com/) with one click. Bridge your notes and AI coding workflow.

Repository: https://github.com/xingzixhh/switch2cursor

## Features

- **Open vault**: Open the entire vault folder in Cursor
- **Open current note**: Open the active Markdown file in Cursor
- **Smart window reuse**: Detect whether Cursor already has the target directory open (including sub-projects in `.code-workspace`); reuse the window if so, otherwise open a new one
- **File explorer context menu**: Right-click any file or folder to open it in Cursor
- **Editor context menu**: Right-click inside a note to jump to Cursor
- **Command palette**: `Open vault in Cursor` / `Open current file in Cursor`
- **Ribbon icon**: Click the external-link icon to open the current note

## Installation

### From the community plugin directory

1. Open **Settings → Community plugins → Browse**
2. Search for **Switch2Cursor**
3. Install and enable the plugin

### Manual install (development)

1. Copy this project into your vault plugin folder:

   ```
   <your-vault>/.obsidian/plugins/switch-to-cursor/
   ```

2. Build the plugin:

   ```bash
   npm install
   npm run build
   ```

3. Enable **Switch2Cursor** under **Settings → Community plugins**

## Requirements

- Desktop app only (Windows / macOS / Linux)
- [Cursor](https://cursor.com/) installed, with the `cursor` CLI available (enable "Add to PATH" during installation)

## Usage

| Action | How |
|--------|-----|
| Open current note | Click the ribbon icon, or run `Open current file in Cursor` from the command palette |
| Open entire vault | Run `Open vault in Cursor` from the command palette |
| Open a file or folder | Right-click in the file explorer → **Open in Cursor** |
| Jump from editor | Right-click inside a note → **Open in Cursor** |

Configure the Cursor command path, cursor navigation, notifications, and debug options under **Settings → Switch2Cursor**.

## Cursor CLI paths

| Platform | Default command |
|----------|-----------------|
| Windows | `C:\Program Files\Cursor\Cursor.exe` |
| macOS | `/Applications/Cursor.app/Contents/MacOS/Cursor` |
| Linux | `cursor` |

## Development

```bash
npm install
npm run dev    # watch mode, outputs main.js
npm run build  # production build
```

Source code lives in `src/`. Internal documentation is available in [`project_document/`](project_document/).

Chinese documentation: [`README.zh-CN.md`](README.zh-CN.md)

## License

MIT