README.ja.md

English | 日本語

---

gitpulse は、git 履歴をローカルで解析し、リッチなターミナルダッシュボードでリポジトリ健全性メトリクスを表示する Python CLI ツールです。SaaS や API キーは不要で、完全にオフラインで任意の git リポジトリで動作します。

機能

• コミット速度 — 頻度ヒートマップ、トレンド検出、ピークアクティビティの特定
• ホットファイル — 変更頻度とコードチャーンでファイルをランク付け
• ブランチ比較 — ahead/behind 統計と diff サマリーでリファレンスを比較
• 健全性スコア — 設定可能なチェックと CI 連携による複合リポジトリ健全性評価
• 作者内訳 — コントリビュータ統計、アクティビティパターン、分布チャート
• 複数出力形式 — リッチテーブル、JSON、CSV

インストール

PyPI から（推奨）

pip install gitpulse

ソースから

git clone https://github.com/izag8216/gitpulse.git
cd gitpulse
pip install -e .

クイックスタート

# 過去30日間のコミット速度を分析
gitpulse analyze

# 上位20のホットファイルをチャーン閾値付きで表示
gitpulse hotfiles --top 20 --churn-threshold 0.3

# ブランチを比較
gitpulse compare main..feature --summary

# リポジトリ健全性スコア
gitpulse health --checks all --fail-below 70

# 作者の貢献
gitpulse authors --top 10 --pie

コマンド

コマンド	説明	例
analyze	コミット速度ダッシュボード	gitpulse analyze --period 90d
hotfiles	ホットファイル・チャーンランキング	gitpulse hotfiles --top 20 --ext py,js
compare	ブランチ/リファレンス比較	gitpulse compare main..feature
health	リポジトリ健全性スコア	gitpulse health --output json
authors	作者貢献内訳	gitpulse authors --pie

ライセンス

MIT License — 詳細は LICENSE を参照してください。