エディタ連携

kizamiはVS Code拡張機能を提供しています。ターミナルで kizami blame を実行しなくても、編集中のファイルに関連するドキュメントをエディタ上で直接確認できます。

← ドキュメントトップへ


VS Code拡張機能

kizami VS Code拡張機能は、現在編集中のファイルを参照しているADRや設計ドキュメントをサイドバーに表示します。

インストール

VS Code拡張機能マーケットプレイスで kizami を検索するか、拡張機能パネル(Ctrl+Shift+X / Cmd+Shift+X)から kizami と入力してインストールします。

要件:

  • kizami CLI がインストール済みで PATH に含まれていること(または kizami.binaryPath で設定済みであること)
  • kizami.toml を含むワークスペース(kizami init で生成)

機能

関連ドキュメントのサイドバー

ソースファイルを開くと、アクティビティバーの kizami パネルに、そのファイルを ## Related Files セクションや .kizami サイドカーで参照しているすべてのドキュメントが自動的に表示されます。

ドキュメントをクリックすると、VS Codeの組み込みMarkdownプレビューで開きます。

エディタで開く

サイドバーのドキュメント項目を右クリックして エディタで開く を選択すると、テキストファイルとして開いて編集できます。

エクスプローラーのコンテキストメニュー

エクスプローラーパネルで任意のファイルを右クリックし、kizamiの関連ドキュメントを検索 を選択すると、ファイルを開かずにそのファイルに関連するドキュメントを表示できます。

更新

ドキュメントがVS Code外で更新された場合は、サイドバーのタイトルバーにある更新ボタンで kizami blame を手動で再実行できます。


設定

設定 デフォルト 説明
kizami.binaryPath "kizami" kizamiバイナリのパス。PATH に含まれていない場合に設定します。

設定を変更するには、VS Code設定(Ctrl+, / Cmd+,)を開いて kizami と検索してください。


動作の仕組み

拡張機能はファイルを切り替えるたびにバックグラウンドで kizami blame <ファイル> を実行し、その出力を解析してサイドバーに表示します。データが外部に送信されることはなく、すべてインストール済みのkizamiバイナリを使ってローカルで処理されます。


リンク