Skip to content

Repository files navigation

NaviCom

Powered by OrcaRouter

ペアプログラミングのナビゲーター役を担う、VS Code 向け AI 学習支援拡張機能

NaviCom は、コーディング中の詰まりを自力で解決する力を育てることを目的とした VS Code 拡張機能です。
GitHub Copilot、LM Studio、Ollama、OrcaRouterを利用し、「答えの代行」ではなく「考え方・観点・切り分け方」の提示に特化したアドバイスを提供します。


コンセプト

  • ペアプログラミングにおけるナビゲーター役を AI に担わせる
  • 正解を与えるのではなく、考えるための観点・確認ポイント・次に見るべき箇所を提案する
  • コードの変更・自動実行・ターミナル操作は行わない
  • 詰まりや学びを個人ナレッジとして手元に蓄積し、次回以降に活かせるようにする

できること

文脈を踏まえた AI 相談

現在開いているファイル・選択範囲・診断情報・直近の編集内容・関連シンボルを自動で収集し、プロジェクトの文脈に沿ったアドバイスを返します。入力欄から自由なテキストで補足情報を追加することもできます。

入力欄の「送信予定」表示では、送信する情報のカテゴリ、対象ファイル、概算サイズを確認できます。通常はコンパクトに表示され、必要なときだけ詳細を展開できます。外部AIへ送るファイルパスはワークスペース相対パスへ変換されます。

相談履歴の保存・再閲覧

相談ごとに独立した履歴が作成され、質問と回答を専用画面へ保存して後から再閲覧できます。コンテキスト増大や過去回答への過度な依存を防ぐため、各AIリクエストはステートレスです。履歴画面から同じ相談へ戻って質問を追加しても、過去の発言はAI入力へ自動送信されません。必要な内容は現在の質問または追加コンテキストへ含めてください。追加コンテキストは相談途中でも編集でき、変更内容は次回の質問または自動助言から使用されます。回答に表示された参照ファイルは、一覧からクリックしてVS Codeのエディタで開けます。履歴とナレッジの削除は、誤操作を防ぐため二度押しで確定します。

常時モードと必要時モード

  • 必要時モード:  ユーザーが明示的に質問を送ったときだけアドバイスを返します。
  • 常時モード:  編集・選択・診断の変化をトリガーに、自動で作業文脈を読んでフィードバックします。  発話頻度はアイドル時間・インターバル・重複抑制・一時停止で制御されます。

個人ナレッジの蓄積と再利用

有用な回答からナレッジ下書きを作成できます。AIが整理した内容を詳細画面で確認して明示的に有効化したものだけが、以降の回答生成時に参照されます。検索・閲覧・削除・元会話への遡りも可能です。 ナレッジ本体はローカルの SQLite に保存されます。ただし、回答生成時に再利用対象となったナレッジのタイトル・要約は、プロンプトの一部として選択中のAI接続先へ送信されます。


技術構成

領域 技術
拡張機能ホスト TypeScript / VS Code Extension API
UI React / WebviewView
AI 呼び出し VS Code Language Model API (GitHub Copilot) / LM Studio / Ollama / OrcaRouter
ローカルストレージ SQLite (sql.js)
ビルド esbuild / TypeScript Compiler

ディレクトリ構成

src/
├── extension.ts                   # 拡張機能エントリポイント
├── application/
│   ├── NavigatorController.ts     # 画面状態・ユースケース制御
│   └── SessionStore.ts            # セッション状態管理
├── services/                      # AI呼び出し・文脈収集・ナレッジ等
├── shared/
│   ├── types.ts                   # 共有型定義
│   └── messages.ts                # Webview メッセージ定義
└── views/
    ├── NavigatorViewProvider.ts   # WebviewView プロバイダー
    ├── screens/                   # 各画面コンポーネント (s01〜s08)
    └── webview/                   # Webview エントリ・状態管理

前提条件

  • VS Code Desktop 1.99 以上(vscode.dev 等の Web 版は非対応)
  • GitHub Copilot を利用する場合は、VS Code で GitHub にサインインし、Copilot の AI 機能を有効にしていること
    • Copilot Free でも月次上限の範囲で利用できます
    • 認証済みの学生は Copilot Student を無料で利用できます
  • LM Studio を利用する場合は、LM Studio と対象モデルをローカルで起動していること
  • OrcaRouter を利用する場合は、OrcaRouterの紹介リンクから発行した sk-orca- 形式のAPIキー
  • Node.js / npm

セットアップと起動

依存パッケージのインストール

npm install

ビルドして拡張機能を起動(F5)

npm run compile

ビルド完了後、VS Code で F5 キーを押すか、実行とデバッグパネルから Run Extension を選択します。
新しい Extension Development Host ウィンドウが起動し、アクティビティバーに NaviCom アイコンが表示されます。

ウォッチモードでの開発

TypeScript の変更を都度コンパイルする場合は、2つのターミナルでそれぞれ起動します。

# ターミナル1: 拡張機能ホスト
npm run watch

# ターミナル2: Webview
npm run watch:webview

その後、実行とデバッグパネルから Watch Extension を選択して起動します。

初回接続

拡張機能を起動したら、サイドバーの NaviCom パネルを開き、使用する接続先を選びます。

  • Copilot に接続: GitHub Copilot の認可ダイアログを許可します。
  • ローカル LLM に接続: LM Studioでモデルをロードし、ローカルサーバーへ接続します。
  • OrcaRouter に接続: APIキー未設定の場合は設定画面へ移動し、キー入力の案内を表示します。

OrcaRouterの設定

  1. 設定画面の「接続先」で OrcaRouter を選択します。
  2. sk-orca- で始まるAPIキーを入力し、「キーを保存」を押します。保存後、モデル一覧が自動取得されます。
  3. APIキー保存後に表示されるモデルから、初回の無課金動作確認には Free Router (orcarouter/free) を選択します。
  4. 必要に応じて「モデル一覧を更新」で最新のテキストモデルを再取得します。
  5. モデルを変更した場合は画面下部の「保存」を、変更していない場合は「OrcaRouterに接続」を押します。

APIキーはVS CodeのSecretStorageへ保存され、設定データや会話履歴には書き込まれません。保存済みキーの値は設定画面へ再表示されず、推論時にはSecretStorageから最新のキーを取得します。orcarouter/free は無料容量だけを利用し、容量がない場合も有料モデルへ自動移行しません。

OrcaRouter利用時のデータ送信

OrcaRouterを選択すると、回答生成やナレッジ作成に使うプロンプトがOrcaRouterと選択された上流モデル事業者へ送信されます。会話タイトルはローカルで生成し、過去の会話履歴は回答生成へ自動送信しません。プロンプトには、処理に応じて次の情報が含まれます。

  • 現在の質問、追加コンテキスト(ナレッジ作成時のみ対象回答の周辺メッセージ)
  • 送信対象のコード断片、診断情報、ファイル名、ディレクトリ構造、関連シンボル、直近の編集情報
  • 再利用する個人ナレッジのタイトル・要約と、評価理由からローカル生成した定型フィードバック傾向

フィードバック処理によって、任意の補足コメントや回答抜粋を追加送信することはありません。保護済みまたは追加の除外パターンに一致するファイル本文は送信対象から除外されます。APIキーはプロンプトに含めず、VS CodeのSecretStorageからOrcaRouterへの認証にだけ使用します。利用前にOrcaRouterのData Handlingと、利用する上流モデル事業者の規約を確認してください。

OrcaRouterのGuardrail/Firewall

NaviComはOrcaRouterのGuardrail/Firewallを自動的に有効化・設定しません。GuardrailをAPIキーへ適用するか、OrcaRouter側でワークスペース既定のポリシーを設定した場合に、プロンプトや応答が検査されます。ポリシー未設定の状態で、NaviComから同じ推論エンドポイントを使うだけでは自動適用されません。

現在のNaviCom連携は通常のChat Completionsとしてテキストだけを送り、ツール定義やツール呼び出しを送信・実行しません。このため、Agent Firewallのツール実行制御は現在の連携経路では利用しません。Guardrailにより個別のリクエストが拒否された場合は、その旨を表示し、OrcaRouterとの接続自体は維持します。

OrcaRouterの料金表示

応答の usage.cost_usd は「応答時点の記録料金」として表示します。この値は応答生成時に計算された情報であり、確定請求額とは限りません。確定した請求情報はOrcaRouter側の利用履歴、またはGET /v1/generationで確認してください。usage.cost_usd がない応答や過去データは、NaviComの参考料金概算を表示します。

実装ドキュメント

プロバイダーごとの接続・モデル選択・推論・設定・制約は AIプロバイダーの実装 にまとめています。

常時モードの役割選択・観測情報・古い回答の抑止は 自動助言のフォーカス判定 を参照してください。

機能設計書は docs/01〜docs/15 の連番で管理し、プロバイダー文書は docs/provider に分離しています。

プライバシーとライセンス

Privacy Policy / License

商標について

GitHubおよびGitHub CopilotはGitHub, Inc.の商標です。LM StudioはElement Labs, Inc.の商標です。OrcaRouterは各権利者に帰属する商標です。NaviComはこれら各社が開発、承認、後援する公式製品ではありません。プロバイダーのブランドアセットは、対応する接続先を識別する目的に限って使用しています。

Ollama

Ollamaはユーザー自身でインストール・起動し、使用するモデルを事前にインストールしてください。 接続画面または設定画面で Ollama を選択すると、GET /api/tags からインストール済みモデルを取得します。 設定画面で接続先URL(既定: http://localhost:11434)とモデルを選び、設定を保存してください。 別ホスト・ポートのHTTP(S)ルートURLも指定できます。指定先へコードのコンテキストが送信されます。 設定はワークスペースごとに保存され、VS Codeの再起動後にも復元されます。 モデルを追加・削除した場合は「モデル一覧を更新」を使用してください。保存済みモデルが削除されていた場合は選び直します。

NaviComはOllamaのHTTP APIのみを使用し、プロセスの起動・終了、モデルのダウンロードは行いません。 別プロバイダーへの切り替え成功時、最後に生成で使用したモデルへ POST /api/generate(keep_alive: 0)を送信します。 アンロードは最大2秒のbest-effortで、失敗しても切り替えは継続し、Extension Hostログに記録します。 終了時は終了処理を遅らせないためアンロードを行わず、Ollama側の保持時間に従います。

生成はLM Studioと共通のOpenAI互換Chat Completions処理を利用します。 現行NaviComのLM Studioと同様、回答は生成完了後に表示します(逐次ストリーミング表示は未対応)。 system prompt・作業中コード・追加コンテキスト・ナレッジ等は通常の生成経路で組み立てます。 会話履歴の保存・再閲覧にも対応しますが、既存仕様どおり過去の会話を毎回の入力に自動追加しません。

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages