Code Assistant

🚀 コードアシスタントプロジェクトドキュメント

コードアシスタントは、開発者がコードライブラリの分析、最適化、理解を支援するための強力なツールです。複数のAIプロバイダをサポートし、タスクモードとサーバーモードの2つのモードで動作します。

✨ 主な機能

• サポートするAIプロバイダには、Anthropic、OpenAI、Vertex AI、OpenRouter、AI Coreが含まれます。
• 複数の言語をサポートし、ユーザーは必要に応じて異なるモデルを選択して分析できます。
• ファイル検索、置換、コマンド実行などの操作をサポートします。
• セッションを記録して後で再生でき、fast-playbackモードも提供します。

📦 インストール

環境変数の設定

• ANTHROPIC_API_KEY: Anthropicプロバイダを使用する場合に設定する必要があります。
• OPENAI_API_KEY: OpenAIプロバイダを使用する場合に設定する必要があります。
• GOOGLE_API_KEY: Vertexプロバイダを使用する場合に設定する必要があります。
• OPENROUTER_API_KEY: OpenRouterプロバイダを使用する場合に設定する必要があります。
• PERPLEXITY_API_KEY: Perplexity search APIツールを使用する場合に設定する必要があります。

💻 使用例

基本的な使用法

タスクモード

タスクモードでは、コードアシスタントはさまざまな分析タスクを実行できます。以下に例を示します。

# 現在のディレクトリのコードライブラリを分析する
code-assistant --task "このコードライブラリの目的を説明する"

# OpenAIを使用して特定のディレクトリを分析する
code-assistant -p open-ai --path ./my-project -t "すべてのAPIエンドポイントをリストする" -v

# Google Vertex AIを使用してコードの複雑度を分析する
code-assistant -p vertex --model gemini-1.5-flash -t "コードの複雑度を分析する"

# Ollamaモデルを使用してTODOコメントを検索する
code-assistant -p ollama -m codellama --task "すべての待办事項コメントを検索する"

# AI Coreプロバイダを使用してドキュメントを作成する
code-assistant -p ai-core --task "公共APIをドキュメント化する"

# ワーキングメモリモードを使用してパフォーマンスのボトルネックを検索する
code-assistant --task "パフォーマンスのボトルネックを検索する" --agent-mode working_memory

# 前回中断したタスクを続行する
code-assistant --continue-task

# グラフィカルユーザーインターフェイスを起動する
code-assistant --ui

# セッションを記録して後で再生する
code-assistant --task "データベースクエリを最適化する" --record ./recordings/db-optimization.json

# 記録されたセッションを再生して高速化する
code-assistant --playback ./recordings/db-optimization.json --fast-playback

サーバーモード

サーバーモードでは、コードアシスタントはModel Context Protocol (MCP)サーバーとして動作します。

code-assistant server [OPTIONS]

📚 ドキュメント

将来の計画（ロードマップ）

以下は、将来の開発重点となる可能性のある項目です。

• セキュリティ: より厳格なサンドボックス環境を提供し、プロジェクトファイルへのアクセスを制限します。
• UIの改善: テキスト入力インターフェイスのユーザー体験を向上させ、Markdownサポートとコードブロックの構文ハイライト機能を追加します。
• エージェントの改善: ワーキングメモリモードとメッセージ履歴モードを最適化し、冗長な情報を自動的に削除する方法を探索します。
• 曖昧なマッチング検索ブロック: より効率的なファイル検索アルゴリズムを研究して、マッチング成功率を向上させます。

🤝 貢献ガイド

どんな貢献も歓迎します！プルリクエストを送信することで、いつでもプロジェクトに貢献できます。