はじめに
GitIngestは、GitHubのコードリポジトリをLarge Language Model (LLM)のヒントに適したテキストに変換するために設計されたオープンソースツールです。簡単な操作で、あらゆるGitHubリポジトリの内容を抽出し、LLMに適したテキストに整形することができます。GitIngestは、FastAPIをバックエンドフレームワークとして、Tailwind CSSをクリーンでレスポンシブなユーザーインターフェースの構築に使用しています。
機能一覧
- ワンクリック分析GitHubリポジトリのURLを貼り付けるだけで、すぐに結果が得られます!
- スマートフォーマットLLMプロンプトの出力形式の最適化
- 統計情報: ファイルとディレクトリの構造、トークンのカウントと統計を提供します。
- ウェブインタフェースシンプルで使いやすいユーザーインターフェース
- インストールと操作pipとDockerによるインストールと実行をサポート。
ヘルプの使用
使いやすいガイド
プロジェクトのアドレス例:https://github.com/pptt121212/freefluxapi/
githubをgitingestに変更
https://gitingest.com/pptt121212/freefluxapi/
インストールと展開プロセス
pipによるインストール
- クローン倉庫
git clone https://github.com/cyclotruc/gitingest.git
cd gitingest
- 依存関係をインストールします:
pip install -r requirements.txt
- アプリケーションを実行する:
cd src
uvicorn main:app --reload
アプリケーションは http://localhost:8000
.
Dockerを使ったインストール
- 鏡像を作る:
docker build -t gitingest .
- コンテナを実行する:
docker run -d --name gitingest -p 8000:8000 gitingest
アプリケーションは http://localhost:8000
.
使用ガイドライン
- ワンクリック分析GitIngestのウェブサイトを開き、GitHubリポジトリのURLを貼り付け、Analyseボタンをクリックすると、リポジトリの構造と内容の概要が表示されます。
- スマートフォーマット分析結果は、LLMプロンプトで直接使用するのに適した最適化された形式で表示されます。
- 統計を見る結果ページでは、ファイルやディレクトリの構造、トークン数、その他の統計情報を見ることができます。
- ウェブインタフェースシンプルで応答性の高いユーザーインターフェースにより、ユーザーは分析結果を簡単にナビゲートし、操作することができます。
詳細な機能操作の流れ
- URLを貼り付ける入力ボックスにGitHubリポジトリのURLを貼り付けます。
- クリック分析分析ボタンをクリックして数秒待つと、システムが自動的に倉庫の中身を抽出して分析します。
- 結果を見るファイルやディレクトリの構造、テキストの内容、統計情報など、分析結果がページに表示されます。
- 要約のダウンロード分析結果の要約ファイルをダウンロードして、オフラインで簡単に閲覧・使用することができます。
GitIngestは、GitHubコードベースをLLMプロンプトに適したテキストに素早く変換する強力な機能とクリーンなプロセスを提供し、生産性と正確性を劇的に向上させます。