SourceSage 5.0.0のクイックスタートガイド

AI・機械学習
2024.06.10

こんにちは！SourceSage 5.0.0を使ってみたいけど、どうやって始めたらいいのかわからない…という方のために、この記事ではSourceSage 5.0.0の使い方を初心者向けに丁寧に解説していきます。一緒に学んでいきましょう！

Release SourceSage v5.0.0 リリースノート · Sunwood-ai-labs/SourceSage
新機能AIRA と Harmon.AI の設定を追加: プロジェクトの自動化とコード生成を強化するために、AIRA と Harmon.AI の設定ファイルを追加しました。これにより、リポジトリ情報、コミットメッセージ、ブランチ名、LLM モデル、README 生成の設定、そして Harmon.AI の環境変数、製品情報...
github.com

セットアップ

まず、SourceSage 5.0.0を使用するには、PythonのパッケージマネージャーであるPIPを使ってインストールする必要があります。以下のコマンドをターミナルまたはコマンドプロンプトで実行してください。

pip install sourcesage

Note: このコマンドにより、SourceSage 5.0.0がシステムにインストールされ、コマンドラインから実行できるようになります。

ステップ1: ターミナルを開く

セットアップが完了したら、ターミナル（Windowsではコマンドプロンプトとも呼ばれます）を開きます。ターミナルを開く方法は、お使いのOSによって異なります。

  • macOS: Finderを開き、アプリケーション > ユーティリティ > ターミナルをクリックします。
  • Windows: スタートメニューを開き、「cmd」と検索ボックスに入力し、Enterキーを押します。
  • Linux: Ctrl + Alt + Tを同時に押すか、アプリケーションメニューからターミナルを探します。

ターミナルが開けたら、次のステップに進みましょう！

ステップ2: プロジェクトのディレクトリに移動

cdコマンドを使って、解析したいプロジェクトのルートディレクトリに移動します。

cd ~/my_project

ここで、~/my_projectは、あなたのプロジェクトのパスに置き換えてください。

Note: cdコマンドは "change directory" の略で、現在のディレクトリを指定したディレクトリに変更するために使用します。

ステップ3: SourceSage 5.0.0を起動

プロジェクトのルートディレクトリに移動したら、以下のコマンドを実行してSourceSage 5.0.0を起動します。

sourcesage

これで、SourceSage 5.0.0が解析を開始します。お茶でも飲みながら、しばらく待ちましょう。

ステップ4: 生成されたファイルを確認

SourceSage 5.0.0の解析が完了すると、SourceSageAssetsディレクトリに以下のファイルが生成されます。

  • Repository_summary.md

    • AIがプロジェクトの構造と内容を理解しやすい形式のマークダウンファイルです。
    • プロジェクトの全体像を把握するのに役立ちます。

  • Changelog

    • Gitの変更履歴を保存するディレクトリです。
    • プロジェクトの変更履歴を追跡できます。

  • ISSUES_RESOLVE

    • Issuesとプロジェクト全体がマージされたファイルを保存するディレクトリです。
    • これらのファイルは、AIがIssueを解決するための重要な情報源となります。

  • COMMIT_CRAFT

    • 開発中のステージされたコードのファイルを保存するディレクトリです。
    • これらのファイルは、AIが適切なコミットメッセージを生成するために使用されます。

  • open_issues_filtered.json

    • GitHubからフェッチしたオープンなIssueのJSONファイルです。
    • プロジェクトの未解決のIssueを確認できます。

  • STAGED_DIFF.md

    • ステージされた変更の差分情報を含むマークダウンファイルです。
    • コミット前の変更内容を確認できます。

これらのファイルを活用することで、AIによるプロジェクトの解析や自動修正、ドキュメント化などを行うことができます。

発展的な使い方

SourceSage 5.0.0には、より高度な機能もあります。以下のコマンドを試してみましょう。

リポジトリ情報の収集と差分情報のレポート作成

sourcesage --mode Sage GenerateReport

このコマンドは、リポジトリ情報を収集し、リリース間の差分情報をレポートとして生成します。

コミットメッセージの生成

sourcesage --mode Sage GenerateReport CommitCraft --model-name "gemini/gemini-1.5-pro-latest"

このコマンドは、ステージされた変更からAIを使ってコミットメッセージを自動生成します。

Note: --model-nameオプションで、使用するAIモデルを指定できます。ここでは、gemini/gemini-1.5-pro-latestを使用しています。

リリースノートの生成

sourcesage --mode DocuMind --docuMind-model "gemini/gemini-1.5-pro-latest" --docuMind-db ".SourceSageAssets\DOCUMIND\Repository_summary.md" --docuMind-release-report ".SourceSageAssets\RELEASE_REPORT\Report_v5.0.0.md"  --docuMind-changelog ".SourceSageAssets\Changelog\CHANGELOG_release_5.0.0.md"  --docuMind-output ".SourceSageAssets/DOCUMIND/RELEASE_NOTES_v5.0.0.md"  --docuMind-prompt-output ".SourceSageAssets/DOCUMIND/_PROMPT_v5.0.0.md"  --repo-name "SourceSage" --repo-version "v0.5.0"

このコマンドは、プロジェクトの概要と変更履歴からリリースノートを自動生成します。

  • --docuMind-model: 使用するAIモデルを指定します。
  • --docuMind-db: プロジェクト概要のマークダウンファイルのパスを指定します。
  • --docuMind-release-report: リリースレポートのパスを指定します。
  • --docuMind-changelog: 変更履歴のマークダウンファイルのパスを指定します。
  • --docuMind-output: 生成されたリリースノートの出力パスを指定します。
  • --docuMind-prompt-output: リリースノート生成のプロンプトの出力パスを指定します。
  • --repo-name: リポジトリの名前を指定します。
  • --repo-version: リポジトリのバージョンを指定します。

以上で、SourceSage 5.0.0の基本的な使い方と発展的な使い方が理解できたと思います。ぜひ、自分のプロジェクトでSourceSage 5.0.0を活用してみてください！

コードの品質向上と開発効率アップに役立つこと間違いなしです。Happy coding!

リポジトリ

GitHub - Sunwood-ai-labs/SourceSage
Contribute to Sunwood-ai-labs/SourceSage development by creating an account on GitHub.
github.com

コメント

タイトルとURLをコピーしました