OpenCode WSL
emmet24276 downloadsEmbed OpenCode web UI in the Obsidian sidebar via WSL bridge.
- Overview
- Scorecard
- Updates5
Embed OpenCode web UI in the Obsidian sidebar via WSL.
Architecture
Obsidian (Windows) WSL (Linux)
┌─────────────────────┐ ┌──────────────────────┐
│ <iframe> │ ← HTTP/SSE →│ opencode serve │
│ OpenCode Web UI │ 127.0.0.1 │ (REST API + Web UI) │
└─────────────────────┘ └──────────────────────┘
Requirements
- Windows 10/11 with WSL2 installed
- OpenCode CLI installed inside WSL (
curl -fsSL https://opencode.ai/install.sh | bash) - Obsidian v1.4.0+
Installation
Via BRAT
- Install BRAT
- Run
BRAT: Add a beta plugin for testing - Enter
https://github.com/emmet24/obsidian-opencode-wsl
Manual
- Download the latest release from GitHub releases
- Extract to
<vault>/.obsidian/plugins/opencode-wsl/ - Enable the plugin in Settings → Community plugins
Usage
- Click the terminal icon in the left ribbon, or run
Toggle OpenCode panelfrom the command palette - The OpenCode server starts automatically inside WSL
- The OpenCode web UI appears in the right sidebar
- Select your vault project in the web UI to start
Auto-start
When enabled (default), the server starts automatically when you open the sidebar panel. When disabled, click "Start OpenCode" in the panel to launch the server manually.
Settings
| Setting | Default | Description |
|---|---|---|
| Auto-start server | ON | Start server automatically when panel opens |
| Server port | 14096 | Port for the OpenCode server |
| WSL distribution | (default) | Leave empty to use the default WSL distro |
| OpenCode path (WSL) | opencode | Path to the opencode executable inside WSL |
| Working directory (WSL path) | auto-detected | Working directory passed via wsl.exe --cd |
| Server password | (empty) | OPENCODE_SERVER_PASSWORD for auth |
Development
git clone https://github.com/emmet24/obsidian-opencode-wsl.git
cd obsidian-opencode-wsl
npm install
npm run build
Files
opencode-wsl/
├── src/
│ ├── main.ts # Plugin entry, settings tab, view registration
│ ├── settings.ts # Settings interface and defaults
│ ├── serverManager.ts # WSL opencode serve process lifecycle
│ └── views/
│ └── opencodeView.ts # iframe-based sidebar view
├── esbuild.config.mjs # Build configuration
├── manifest.json # Plugin metadata
├── styles.css # iframe and status styles
└── package.json # Dependencies
Branches
| Branch | Version | Approach |
|---|---|---|
main |
2.0.0 | ✅ iframe embedding of OpenCode web UI (current) |
| (git history) | 1.0.3 | PTY bridge + xterm.js TUI (archived) |
Related
- OpenCode — The AI platform
- opencode-obsidian — Similar plugin by mtymek
License
MIT
HealthExcellent
ReviewSatisfactory
About
Embed OpenCode web UI in the Obsidian sidebar via WSL. Instead of a PTY bridge (xterm.js + node-pty), this plugin starts 'opencode serve' inside WSL and embeds the web UI in an iframe — no extra dependencies, just a clean HTTP bridge between Windows and WSL.
Features: Web UI embedded in sidebar, auto-start server (configurable), lifecycle management (starts with panel, stops with Obsidian, no lingering processes), WSL-native PATH resolution, automatic vault directory, health check, taskkill cleanup.
Requirements: Windows 10/11 + WSL2, OpenCode CLI in WSL, Obsidian v1.7.2+.
Privacy: Local only (127.0.0.1), no telemetry, no external connections.Details
Current version
2.0.0
Last updated
4 weeks ago
Created
Last month
Updates
5 releases
Downloads
276
Compatible with
Obsidian 1.7.2+
Platforms
Desktop only
License
MIT
Sponsor
Author