SourceSageは、リポジトリの構造と内容を包括的に分析し、AIフレンドリーなドキュメントを生成するツールです。主にRepository_summary.mdの生成とRELEASE_REPORTの作成機能を提供します。
Important
このリポジトリのリリースノートやREADME、コミットメッセージの9割近くはclaude.aiやChatGPT4を活用したAIRA, SourceSage, Gaiah, HarmonAI_IIで生成しています。
- 【2025/02/02】 SourceSage 5.1.0
- DocuSumモジュールをコア機能として統合
- 【2024/06/18】 SourceSage 4.0.0
- ReleaseDiffReportGenerator機能を追加し、2つのタグ間の差分をマークダウンレポート形式で生成
- 【2024/06/16】 SourceSage 3.5.0
- IssueWise機能を追加し、プロジェクトの概要からGitHub Issue作成を自動化
- 【2024/05/17】 SourceSage 3.0.0
- CommitCraft機能を追加し、ステージングエリアの変更を自動解析
- 【2024/04/13】 SourceSage 2.5.0
- DocuMind機能を追加し、プロジェクトの概要とGitの変更履歴を組み合わせてドキュメント化
- 【2024/03/30】 SourceSage 2.0.0
- ChangelogGenerator classを導入し、コードの可読性と保守性を向上
- 言語ごとのシンタックスハイライト機能を追加
- .SourceSageignoreファイルを導入し、不要なファイルやフォルダを自動的に除外
- 【2024/03/29】 初期リリース
SourceSageはシンプルで軽量なリポジトリ分析ツールで、以下の2つの主要機能を提供します:
リポジトリの構造、コミット情報、ファイル統計を包括的に分析し、AIフレンドリーなマークダウンドキュメントを生成します。
出力ファイル: .SourceSageAssets/DOCUMIND/Repository_summary.md
含まれる情報:
- 🌳 プロジェクトツリー構造
- 📋 Gitリポジトリ情報
- 📈 ファイルサイズと行数統計
- 📝 ファイル内容の詳細
Gitタグ間の差分を分析し、リリースレポートを自動生成します。
出力ファイル: .SourceSageAssets/RELEASE_REPORT/Report_{latest_tag}.md
含まれる情報:
- 🏷️ バージョン比較
- 🔄 変更差分の詳細
- 📋 コミット履歴
pip install sourcesage# プロジェクトをクローン
git clone https://github.com/Sunwood-ai-labs/SourceSage.git
cd SourceSage
# 環境構築と依存関係のインストール
uv sync
# 実行
uv run sourcesage
# または短縮コマンド
uv run ss# フルコマンド
sourcesage
# 短縮コマンド
ss出力: .SourceSageAssets/DOCUMIND/Repository_summary.md
# Repository Summary + Release Reportを同時生成
sourcesage --ss-mode GenerateReport
# 短縮コマンド
ss --ss-mode GenerateReport出力: .SourceSageAssets/RELEASE_REPORT/Report_{latest_tag}.md
# 特定のモードで実行
ss --ss-mode Sage # Repository Summaryのみ
ss --ss-mode GenerateReport # Release Reportのみ
ss --ss-mode all # すべての機能(デフォルト)
# 出力ディレクトリの指定
ss --ss-output ./custom-output/
# 無視ファイルの指定
ss --ignore-file .gitignore# Project: SourceSage
```plaintext
OS: posix
Directory: /path/to/project
├── .SourceSageignore
├── pyproject.toml
├── sourcesage/
│ ├── __init__.py
│ ├── cli.py
│ └── modules/
│ ├── DocuSum/
│ └── DiffReport/
│ ├── __init__.py
│ ├── git_diff.py
│ └── markdown_report.py
└── README.md- 📅 作成日時: 2025-02-02 16:22:31
- 📁 総ディレクトリ数: 5
- 📄 総ファイル数: 15
- 📏 最大深度: 3
## 🛠️ 開発環境
SourceSageは現代的なPython開発環境をサポートしています:
- **Python**: 3.8以降
- **パッケージ管理**: uv / pip
- **ビルドシステム**: hatchling
- **設定ファイル**: pyproject.toml
### 開発用セットアップ
```bash
# uvを使った開発環境構築
git clone https://github.com/Sunwood-ai-labs/SourceSage.git
cd SourceSage
uv sync
# テスト実行
uv run pytest
# コードフォーマット
uv run black sourcesage/
uv run isort sourcesage/
# パッケージビルド
uv build
- name: Generate Repository Summary
run: |
pip install sourcesage
ss
- name: Generate Release Report
run: |
ss --ss-mode GenerateReport#!/bin/bash
# 複数プロジェクトの一括分析
for dir in */; do
cd "$dir"
ss --ss-output "../analysis/$dir"
cd ..
doneSourceSageの改善にご協力ください!バグの報告や機能追加の提案がある場合は、GitHubリポジトリでIssueを開くかプルリクエストを送信してください。
このプロジェクトはMITライセンスの下で公開されています。