Skip to content

derekross/obsidian-opencode-sidebar

Repository files navigation

OpenCode Sidebar for Obsidian

Run OpenCode directly in your Obsidian sidebar.

OpenCode running in Obsidian sidebar

Requirements

  • Obsidian (desktop only)
  • Python 3.x
  • opencode binary installed and available in PATH
  • On Windows: pywinpty (pip install pywinpty)

Installation

Quick Install

Run these commands from your vault's root directory:

mkdir -p .obsidian/plugins/opencode-sidebar
curl -sL https://raw.githubusercontent.com/derekross/obsidian-opencode-sidebar/refs/heads/main/main.js -o .obsidian/plugins/opencode-sidebar/main.js
curl -sL https://raw.githubusercontent.com/derekross/obsidian-opencode-sidebar/refs/heads/main/manifest.json -o .obsidian/plugins/opencode-sidebar/manifest.json
curl -sL https://raw.githubusercontent.com/derekross/obsidian-opencode-sidebar/refs/heads/main/styles.css -o .obsidian/plugins/opencode-sidebar/styles.css

Then enable the plugin in Obsidian Settings > Community Plugins.

Manual Installation

  1. Download main.js, manifest.json, and styles.css from the latest release
  2. Create a folder called opencode-sidebar in your vault's .obsidian/plugins/ directory
  3. Copy the downloaded files into that folder
  4. Enable the plugin in Obsidian Settings > Community Plugins

From Source

git clone https://github.com/derekross/obsidian-opencode-sidebar.git
cd obsidian-opencode-sidebar
npm install
npm run build

Then copy main.js, manifest.json, and styles.css to your vault's .obsidian/plugins/opencode-sidebar/ folder.

Usage

  • Click the OpenCode icon in the left ribbon to open a new OpenCode tab
  • Use the command palette (Ctrl/Cmd+P) and search for "OpenCode" to:
    • Open OpenCode - Opens or focuses an existing OpenCode panel
    • New OpenCode Tab - Creates a new OpenCode instance
    • Close OpenCode Tab - Closes the current OpenCode tab
    • Toggle Focus: Editor <-> OpenCode - Switch between editor and OpenCode

Features

  • Full terminal emulation with xterm.js
  • Automatic theme integration with Obsidian
  • Resize handling
  • Image paste support (saves to temp file and inserts path)
  • Multiple OpenCode instances
  • Keyboard shortcut support

Development

# Install dependencies
npm install

# Watch mode (for development)
npm run dev

# Production build
npm run build

Screenshots

OpenCode Sidebar plugin in Obsidian settings

Author

Derek Ross (@derekross)

License

MIT

About

Run OpenCode directly in your Obsidian sidebar.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •