cpp-reader

Cpp Reader とは？

Cpp Reader とは、LLMと一緒にCppのコードを読むためのツールです。

Important Update

生成したJSONを可視化できる Playgroundを作成しました。よかったら使ってみて下さい！

https://d1bn7mo12i1l5l.cloudfront.net/input

:::note alert BuiltinでないC/C++のVSCode拡張とは共存できません。 Linux Readerを使うときは、BuiltinでないC/C++のVSCode拡張はdisableにしてください。 :::

[できること]

人がコードを読まずともLLMが関数探索してくれる
前に進んだ関数経路に戻れる
調べている関数経路のバグをLLMが見つけてくれる
調べている関数をLLMが図にしてくれる
調べた関数経路をLLMがレポートにしてくれる
調べた関数経路をJSONで保存・再現できる

[効果]

Cppコードをランダムウォークなしに読み進められる
土地勘がないと10分以上かかる数百行、数千行の関数のコードリーディングを、LLMが1分で終わらせてくれる
Cppコードのバグを見つけられる機能がある
頭にいれるだけで暗黙知になりがちな関数経路や関数の説明をLLMがしてくれる
従来は頭にしか入っていなかったコードという暗黙知が形式知にできる

[できないこと/人の作業]

エントリーポイントの把握
LLMによる関数自動探索（人が判断した方が正確）
コードベースを分割せず一括でLLMに調べさせること

用意するもの

clangd(14系以上), Cppのコード, Cppのcompile_commands.json, vscode(1.100.0以上)
OpenAIかAnthropicかPLaMoのAPIキー

Cppコードベース、clangdの準備

git clone <your repository>
brew install clangd

compile_commands.json の用意

https://zenn.dev/tmsn/articles/6317bdf591bc97

なども参考にする

make defconfig
bear -- make LLVM=1 -j16

など...

vscode のインストール

1.100.0 以上をインストールしてください

VSCode で CppReader をダウンロード

https://marketplace.visualstudio.com/items?itemName=coffeecupjapan.cpp-reader&ssr=false#overview

開く

ダウンロード完了したら、「Command + Shift + p」でコマンドパレットを開き、「Open Cpp Tab」をクリック
クリック後に、右側にタブウィンドウが出てくれば成功です

設定の入力 clangdのパス、Cppのパス、compile_commands.json のディレクトリのパス、LLM（OpenAI・Claude・Plamo）を入力
チャット画面で探索を開始最初に、「探索を開始するファイルパス」「探索を開始する関数」「探索の目的」を入力すれば、探索を開始できます。
探索を制御しばらくすると、LLMが関数のステップを説明したのちに、関数の中から重要な関数を選ぶので、そこから内容を探索したい関数を選択します。
すると、またLLMが関数の中から重要な関数を選ぶので、そこから再度探索したい関数を選択します。
以上の流れを、自分がいいと思うまで続けます。

Release Notes

1.0.28

Update Doc

1.0.27

.が間違って指定されるバグ修正

1.0.26

hpp探索時にhppも指せるようにしたい

1.0.25

hpp探索ミスのバグ修正21

1.0.24

hpp探索ミスのバグ修正20

1.0.23

hpp探索ミスのバグ修正19

1.0.22

hpp探索ミスのバグ修正18

1.0.21

hpp探索ミスのバグ修正17

1.0.20

hpp探索ミスのバグ修正16

1.0.19

hpp探索ミスのバグ修正15

1.0.18

hpp探索ミスのバグ修正14

1.0.17

hpp探索ミスのバグ修正13

1.0.16

hpp探索ミスのバグ修正12

1.0.15

hpp探索ミスのバグ修正11

1.0.14

hpp探索ミスのバグ修正10

1.0.13

hpp探索ミスのバグ修正9

1.0.12

hpp探索ミスのバグ修正8

1.0.11

hpp探索ミスのバグ修正7

1.0.10

hpp探索ミスのバグ修正6

1.0.9

hpp探索ミスのバグ修正5

1.0.8

hpp探索ミスのバグ修正4

1.0.7

hpp探索ミスのバグ修正3

1.0.6

hpp探索ミスのバグ修正2

1.0.5

hpp探索ミスのバグ修正

1.0.4

LSPのrestartのバグ修正

1.0.3

LSPのバグの修正

1.0.2

READMEの修正

1.0.1

CppReaderの最初のリリース

Kazuya Kurihara