Featured image of post OpenCode + Obsidian:AI駆動のナレッジマネジメントワークフローを構築する

OpenCode + Obsidian:AI駆動のナレッジマネジメントワークフローを構築する


📋 目次


一、opencode-obsidianプラグインとは?

opencode-obsidianは、OpenCode AIアシスタントをObsidianウィンドウに直接埋め込むサードパーティコミュニティプラグインです。従来のターミナル統合ソリューションとは異なり、このプラグインはOpenCodeのWebビューを使用して直接埋め込むため、表示されるのは完全なOpenCodeインターフェースであり、ターミナルとObsidianの間を行き来する必要がありません。

コア機能:

  • 🖥️ OpenCodeインターフェースがObsidianのサイドバーやメインエディタに直接埋め込み
  • 🔄 サーバーの自動管理——パネルを開くと起動、閉じると停止
  • 📄 実験的なコンテキスト注入——現在開いているノートと選択テキストを自動的にAIに渡す
  • ⌨️ ショートカット Ctrl/Cmd + Shift + O でパネルを素早く切り替え

適用シーン:

  • 長文コンテンツの要約と精製
  • 執筆、編集、推敲
  • ナレッジベースの検索と探索
  • アウトラインと構造化ノートの生成

⚠️ プラグイン作者はOpenCode / Obsidianとは無関係で、これは独立したサードパーティプロジェクトです。現在のバージョンは0.2.1(Beta段階)、デスクトップのみ対応。


二、環境準備

始める前に、以下の準備ができていることを確認してください:

項目 要件 説明
Obsidian ≥ 1.4.0 公式サイトからダウンロード
Node.js ≥ 18+ ダウンロード、OpenCodeのインストールに必要

準備ができたら、以下の手順に従ってください。


三、BRATプラグインのインストール

BRAT(Beta Reviewer’s Auto-update Tool)は、コミュニティプラグインマーケットプレイスにまだ公開されていないBeta版プラグインをインストールするためのObsidianコミュニティプラグインです。opencode-obsidianはまだ正式に公開されていないため、BRATでのインストールが必要です。

ステップ1:コミュニティプラグインマーケットプレイスを開く

Obsidianで順にクリック:設定 → サードパーティプラグイン → 「セーフモード」をオフ → コミュニティプラグインマーケットプレイス

ステップ2:BRATを検索してインストール

コミュニティマーケットプレイスでBRATを検索(正式名称:Obsidian42 - BRAT)、「インストール」→「有効化」をクリック。

💡 BRATはBeta Reviewer’s Auto-update Toolの略で、TfTHackerによって開発されました。Betaプラグインの更新を自動的に検出し、アップグレードを通知します。


四、BRATでopencode-obsidianをインストール

BRATがインストールできたら、それを使ってopencode-obsidianプラグインをインストールできます。

ステップ1:BRAT設定を開く

設定 → サードパーティプラグイン → インストール済みのBRATを見つけ、右側の歯車アイコンをクリックして設定に入ります。

ステップ2:Betaプラグインを追加

BRAT設定ページで、**「Add Beta plugin」**ボタンをクリック。

ステップ3:リポジトリアドレスを入力

ポップアップの入力ボックスに以下を入力:

1
mtymek/opencode-obsidian

**「Add Plugin」**をクリック。

BRATがGitHubから最新のリリースバージョンを自動的に取得してインストールします。

ステップ4:プラグインを有効化

インストール完了後、設定 → サードパーティプラグイン → 「インストール済みプラグイン」リストでOpenCode-Obsidianを見つけ、スイッチをオンにして有効化します。

✅ 有効化後、Obsidianの左サイドバーにターミナル風のアイコンが表示されます——これがOpenCodeのエントリーポイントです。

自動更新

BRATは定期的にGitHubの新しいバージョンをチェックします。更新があると、Obsidian内で通知が表示され、確認をクリックするだけで自動アップグレードされます。


五、OpenCode CLIのインストール

プラグイン自体は「シェル」に過ぎません——バックグラウンドでopencode serveサービスを起動し、OpenCodeのWebインターフェースをObsidianに埋め込みます。そのため、npmでOpenCode CLIをインストールするだけで十分です。

システムのターミナルを開きます(WindowsはPowerShell、macOS/LinuxはTerminal):

1
npm i -g opencode-ai

インストール確認:

1
2
opencode --version
# 期待出力例: 1.14.39

⚠️ Windowsユーザー:プラグインが「Executable not found at ‘opencode’」と表示する場合、本文の第十節にジャンプして解決策を確認してください。


六、プラグイン設定の詳細

プラグインを有効化した後、設定 → サードパーティプラグイン → OpenCode-Obsidianの歯車アイコンから、以下の設定項目を確認できます:

基本設定

設定項目 デフォルト 説明
OpenCode実行ファイルパス opencode システムPATHで見つからない場合、フルパスを入力
ポート 14096 OpenCodeサービスがリッスンするポート番号
ホスト名 127.0.0.1 サービスがバインドするアドレス
プロジェクトディレクトリ (Vaultパスから自動取得) OpenCodeが操作する作業ディレクトリ
起動タイムアウト 45000 (45秒) サービス起動を待つ最大ミリ秒数

インターフェース設定

設定項目 デフォルト 説明
デフォルトビューポジション sidebar sidebar = サイドバー、main = メインエディタ
自動起動 オフ Obsidian起動時にOpenCodeサービスを自動起動

コンテキスト注入(実験的)

設定項目 デフォルト 説明
ワークスペースコンテキスト注入 オフ 現在のノート情報をOpenCodeに自動転送
最大ノート数 20 コンテキストに含まれる最大ノート数
最大選択テキスト長 2000 AIに渡す選択テキストの文字数上限

カスタムコマンド

設定項目 デフォルト 説明
カスタムコマンドを使用 オフ 有効にするとOpenCode起動コマンドをカスタマイズ可能
カスタムコマンド (空) カスタム起動コマンド(第九節を参照)

七、初回使用

OpenCodeパネルを開く

OpenCodeを開く3つの方法:

  1. サイドバーアイコンをクリック:左サイドバーのターミナルアイコンをクリック
  2. ショートカット:Ctrl + Shift + O(macOSはCmd + Shift + O)
  3. コマンドパレット:Ctrl/Cmd + P → Toggle OpenCode panelと入力

初回起動フロー

パネルを開くと、プラグインが自動的に以下を実行:

  1. OpenCode実行ファイルパスを検出
  2. OpenCodeサービスを起動(opencode serve)
  3. 埋め込みWebビューにOpenCodeインターフェースを読み込み

起動成功後、完全なOpenCodeダイアログインターフェースが表示され、プロンプトを直接入力できます。

すべてが正常に動作しているか確認

OpenCodeインターフェースで以下を入力:

1
/help

コマンド一覧が表示されれば、すべて正常です。以下も入力できます:

1
/models

利用可能なAIモデルを確認。OpenCodeには無料モデル(GLM-4.7、MiniMax-2.1)が内蔵されており、設定不要ですぐ使えます。

ショートカット早見表

ショートカット 機能
Ctrl/Cmd + Shift + O OpenCodeパネルの切り替え

八、コンテキスト注入(実験的機能)

これはopencode-obsidianプラグインの最もユニークな機能の1つ——Obsidianの作業コンテキストをOpenCodeに自動的に渡せます。

有効にする方法

プラグイン設定で、**「ワークスペースコンテキスト注入」**スイッチをオンにします。

注入される内容

有効にすると、プラグインは以下の情報を実行中のOpenCodeインスタンスに自動転送します:

  • 📂 現在開いているノート一覧:どのファイルを編集中か
  • 📝 選択テキスト:ノートでハイライトしたテキスト

使用シーン

  1. テキストを選択してOpenCodeパネルを開き、「この文章を推敲して」と言う——AIはすでにどのテキストかを知っている
  2. 複数のノートを同時に開き、AIに「この2つのノートの違いを比較して」と頼む——AIはすでにどのファイルが開いているかを知っている

制限事項

⚠️ これは実験的機能で、現在いくつかの制限があります:

  • OpenCodeインターフェースで新しいSessionを作成する時、コンテキストは自動注入されない
  • コンテキスト更新には一定の遅延がある

九、カスタムコマンドモード

デフォルトでは、プラグインはopencode serveコマンドでサービスを起動します。より多くの制御が必要な場合は、カスタムコマンドモードを有効にしてください。

カスタムコマンドが必要な場合

  • 追加のCLI引数が必要な場合
  • カスタム起動スクリプトを使用する場合
  • コンテナや仮想環境でOpenCodeを実行する場合
  • OpenCodeが非標準パスにインストールされている場合

設定手順

  1. プラグイン設定で**「カスタムコマンドを使用」**をオン
  2. **「カスタムコマンド」**入力ボックスに完全なコマンドを入力

コマンドテンプレート

1
opencode serve --port 14096 --hostname 127.0.0.1 --cors app://obsidian.md

⚠️ 重要な注意事項

  • ポートとホスト名は設定の値と一致している必要があります
  • --cors app://obsidian.mdを含める必要があります——さもないとObsidianがOpenCodeのWebインターフェースを埋め込めません

十、よくある質問とトラブルシューティング

❌ OpenCode実行ファイルが見つからない

症状:パネルを開くと「Executable not found at ‘opencode’」と表示されるが、ターミナルでopencodeは正常に動作する。

原因:Electron(Obsidianの基盤フレームワーク)がWindowsでシステムPATH環境変数を完全に継承しない。

解決策:

  1. ターミナルでopencode.cmdのフルパスを検索:
1
where opencode.cmd
  1. 出力されたフルパスをプラグイン設定の「OpenCode実行ファイルパス」に貼り付け、例:
1
C:¥Users¥あなたのユーザー名¥AppData¥Roaming¥npm¥opencode.cmd

❌ サービス起動タイムアウト

考えられる原因:ネットワークの問題、モデル読み込みの遅さ、ポートが使用中。

解決策:

  • ポート14096が他のプログラムで使用されていないか確認
  • ポート番号を変更してみる(例:15096に)
  • 起動タイムアウト時間を増やす

❌ パネルが空白で表示される

考えられる原因:CORS設定が正しくない。

解決策:

カスタムコマンドを使用している場合、コマンドに--cors app://obsidian.mdが含まれていることを確認してください。

❌ パネルを埋め込めない

考えられる原因:OpenCodeのバージョンが古い。

解決策:

1
npm i -g opencode-ai@latest

❌ 中国語ファイル名の文字化け(Windows)

解決策:PowerShellで実行:

1
chcp 65001

その後、Obsidianを再起動してください。

❌ プラグイン更新後に再設定が必要

BRATはプラグイン更新時に設定データを保持します。設定が失われている場合は、設定ページを開いて再設定してください。


まとめ

インストールフロー全体を一図でまとめると:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
┌──────────────────────────────────────────┐
│        BRATプラグインをインストール         │
│  設定 → コミュニティマーケットプレイス      │
│  → BRATを検索 → インストール              │
└──────────────────┬───────────────────────┘
                   │
                   ▼
┌──────────────────────────────────────────┐
│   BRATでopencode-obsidianをインストール    │
│   BRAT設定 → Add Beta plugin              │
│   入力: mtymek/opencode-obsidian          │
└──────────────────┬───────────────────────┘
                   │
                   ▼
┌──────────────────────────────────────────┐
│        OpenCode CLIをインストール          │
│   npm i -g opencode-ai                   │
└──────────────────┬───────────────────────┘
                   │
                   ▼
┌──────────────────────────────────────────┐
│      プラグインを有効化して使用開始         │
│   Ctrl+Shift+Oでパネルを開く              │
│   Obsidian内でOpenCodeを直接使用          │
└──────────────────────────────────────────┘

一言まとめ:BRATをインストール → mtymek/opencode-obsidianを検索 → OpenCode CLIをインストール → Ctrl+Shift+Oで始めよう。これだけ簡単です。


📚 参考元:

comments powered by Disqus
Hugo で構築されています。
テーマ Stack は Jimmy によって設計されています。