gupta29470/codewalk

codewalk は何をしますか？

AIを活用したコードベースオンボーディングツール — 任意のリポジトリを指定して、コードについて質問できます。tree-sitter解析、RAG、ローカルLLMを使用します。

概要

codewalkは、開発者が新しいコードベースを迅速に理解し、質問に答えるためのインテリジェントなツールです。tree-sitterを用いた構文解析、RAGによる文脈検索、そしてローカルLLMによる推論を組み合わせることで、コードに関する質問に対して正確で文脈に沿った回答を提供します。

特徴

• AI駆動のコード理解: 自然言語でコードベースについて質問できます。
• tree-sitter解析: コードの構造を正確に解析し、意味のある単位で情報を抽出します。
• RAG検索: 検索拡張生成により、関連するコードスニペットやドキュメントを効率的に取得します。
• ローカルLLM: プライバシーを重視し、ローカル環境で動作するLLMを使用します。

使用方法

# リポジトリをクローン
$ git clone <repository_url>
# codewalkを起動
$ codewalk --repo <path_to_repo>

次に、コードについて質問を開始します：

> このプロジェクトの主要なモジュールは何ですか？
> この関数はどのように動作しますか？
> バグの原因と思われる箇所はどこですか？

対応プラットフォーム

• Claude Code
• Cursor
• Codex
• その他のAIエージェントツール

設定

codewalkは、以下の環境変数で設定をカスタマイズできます：

• CODEWALK_LLM_MODEL: 使用するローカルLLMモデル（デフォルト: llama3）
• CODEWALK_TREE_SITTER_GRAMMAR: tree-sitterの文法ファイルパス
• CODEWALK_RAG_CHUNK_SIZE: RAGのチャンクサイズ（デフォルト: 500）

依存関係

• Python 3.8以上
• tree-sitter
• ローカルLLM（例: Ollama、llama.cpp）

詳細情報

詳細なドキュメントはプロジェクトリポジトリを参照してください。