Code Embeddings

🚀 コード知識ツール

このツールは、コードリポジトリの知識管理システムです。ベクトル埋め込み技術を利用して、コードライブラリ内の知識の維持と検索を支援します。

🚀 クイックスタート

このコード知識ツールは、コードリポジトリの知識を管理および検索するために、先進的な埋め込み技術を利用しています。以下に、構築、インストール、使用方法を説明します。

📦 インストール

1. パッケージの構築

まず、配布用のファイルを生成します。

# リポジトリをクローン
git clone https://github.com/yourusername/code-knowledge-tool.git
cd code-knowledge-tool

# 仮想環境を作成してアクティブ化
python -m venv venv
source venv/bin/activate

# ビルドツールをインストール
python -m pip install --upgrade pip build

# パッケージをビルド
python -m build

これにより、dist/ ディレクトリに以下の2つのファイルが生成されます。

• code_knowledge_tool-0.1.0-py3-none-any.whl（インストール用のホイールファイル）
• code_knowledge_tool-0.1.0.tar.gz（ソース配布版）

2. パッケージのインストール

前提条件

1. Ollama がインストールされ、実行されていることを確認します。

# まだインストールされていない場合は、Ollama をインストール
curl https://ollama.ai/install.sh | sh

# Ollama サービスを起動
ollama serve

2. パッケージをインストールします。

方法 1：ホイールファイルからのインストール（使用に推奨）

# ビルドされたパッケージのディレクトリに移動
cd /path/to/code-knowledge-tool

# ホイールファイルを使用してインストール
pip install dist/code_knowledge_tool-0.1.0-py3-none-any.whl

方法 2：開発モードでのインストール（開発に推奨）

この方法は、ツールを変更したり、開発に参加したい場合に適しています。

# すでに code-knowledge-tool ディレクトリにいて、仮想環境がアクティブ化されていると仮定
# 開発依存関係を含めて開発モードでインストール
pip install -e ".[dev]"

📚 ドキュメント

RooCode/Cline との統合

1. MCP 設定をあなたの設定にコピーします。

Cline（VSCode）の場合：

# 設定ファイルを開く
open ~/Library/Application\ Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/cline_mcp_settings.json

以下の設定を追加します。

{
  "mcpServers": {
    "code_knowledge": {
      "command": "python",
      "args": ["-m", "code_knowledge_tool.mcp_tool"],
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      }
    }
  }
}

RooCode の場合：

# 設定ファイルを開く
open ~/Library/Application\ Support/RooCode/settings/mcp_config.json

以下の設定を追加します。

{
  "mcpServers": {
    "code_knowledge": {
      "command": "python",
      "args": ["-m", "code_knowledge_tool.mcp_tool"],
      "env": {
        "PYTHONPATH": "${workspaceFolder}"
      }
    }
  }
}

✨ 主な機能

メモリバンクおよび RAG コンテキストプロバイダとしての機能

このツールは、コードリポジトリのメモリバンクとして機能し、コード知識をベクトル埋め込み形式で保存し、類似性検索を通じてこれらの知識を検索することができます。これは、コード補完、コードコンテキストの理解、開発支援に非常に役立ちます。

🔧 テストと検証

1. テスト依存関係のインストール

より詳細なテストやツールの機能を検証する場合は、以下のテスト依存関係をインストールします。

pip install -r requirements-test.txt

2. テストの実行

以下のコマンドを実行して、単体テストと統合テストを実行します。

pytest tests/

🔮 未来の展望

このツールを PyPI（Python パッケージインデックス）に公開する場合は、以下の手順が必要です。

1. PyPI でアカウントを登録します。
2. twine をインストールします：pip install twine
3. 以下のコマンドを使用して配布版をアップロードします。

   twine upload dist/*
   

ただし、現在はローカルでの構築とインストール方法をお勧めします。

📄 ライセンス

MIT License