本文へ移動

JSON と CSV の出力 ​

スクリプトでは --format json か --format csv を使ってください。表形式の出力は人が読むためのもので、変わることがあります。JSON のスキーマにはバージョンが付いています。

sh
ghusage weekly --format json > weekly.json
ghusage prs --format csv > prs.csv

--include-private を指定しない限り、JSON と CSV では private リポジトリの名前、タイトル、URL を伏せます。private リポジトリを参照してください。

決まりごと ​

  • スキーマのバージョン。 どのレポートにも "schema_version": 1 が入ります。互換性を保つフィールドの追加は、バージョンを変えずに行うことがあります。フィールドを削除したり意味を変えたりするときは、バージョンを変えます。
  • タイムスタンプは RFC 3339 / ISO 8601 の文字列です。period.start と period.end はレポートのタイムゾーンのオフセットを使い(2026-11-02T00:00:00+09:00)、それ以外のタイムスタンプはすべて UTC です(2026-11-01T15:00:00Z)。
  • 時間の長さは秒単位の整数です(_secs で終わるフィールドと、所要時間の統計)。
  • null と 0 の違い。 件数は、何も起きなかったときに 0 になります。null は、不明または該当しないことを表します。たとえば、最後の活動がない、マージされていない、CI の結果がない、対象のプルリクエストが0件で統計を出せない、アカウント ID が不明、といった場合です。
  • フィールドの順序は変わりませんが、順序に依存しないでください。配列には決まった順序があり、それぞれ下で説明します。
  • コマンドに固有のセクションは、そのコマンドが出力しないときは(null にするのではなく)省きます。

レポートのオブジェクト ​

期間を対象にするレポート(overview、daily、weekly、monthly、yearly、repos、prs、reviews、comments、issues)は、次のルートフィールドを持つ JSON オブジェクトを1つ出力します。

フィールド型説明
schema_versioninteger1
accountobject分析の対象: login、id(GitHub の node ID または null)、is_authenticated_user
periodobjectstart(含む)と end(含まない)。レポートのタイムゾーンの RFC 3339 形式
timezonestring暦の境界に使った IANA タイムゾーン
metricsSummary期間全体のまとめ
snapshotSnapshot現在の状態の値
repositoriesRepoSummary の配列リポジトリごとのまとめ。自分の活動の多い順、次に名前の順
activity_breakdownBucketSummary の配列区切りごとのまとめを時刻の順に並べたもの。コマンドが weekly、monthly、yearly でなければ、日ごとの区切りです
granularitystringday、week、month、year。daily、weekly、monthly、yearly のときだけ入ります
coverageCoverageSummary の配列データの種類ごとに1要素
synced_atタイムスタンプまたは nullこのアカウントの最後の同期が終わった時刻
private_repositories_redactedbooleanprivate の名前を伏せたときに true(--include-private なしの JSON/CSV)

コマンドに固有のフィールド:

コマンドフィールド
prspull_requests(PrRow の配列)、intensity(Intensity)、timing(TimingStats)
reviewsreviews_submitted、reviews_received(ReviewRow の配列)
commentscomments(CommentRow の配列)
issuesissues(IssueRow の配列)

各件数の定義は指標の定義にあります。

Summary ​

フィールド型
commits, merge_commitsinteger
prs_created, prs_merged, merges_performed, merges_unknown_actorinteger
prs_closed_without_merge, prs_reopenedinteger
reviews_submittedReviewCounts
reviewed_prsinteger(ユニーク数)
reviews_receivedReviewCounts
reviews_received_from_bots, review_dismissals_performedinteger
comments_written, comments_receivedCommentCounts
review_responses, pr_commits, force_pushesinteger
coordination_actions, metadata_actionsinteger
issues_opened, issues_closed, issues_reopenedinteger
active_prs, active_prs_all_participantsinteger(ユニーク数)
pr_internal_eventsinteger
ciobject: passed、failed、pending、other(integer)。活動には決して含めません
active_daysinteger
last_activityタイムスタンプまたは null
diff_statsDiffTotals

ReviewCounts ​

total、approved、changes_requested、commented、dismissed_unknown_state(integer)。

CommentCounts ​

total、conversation、inline、review_summary(integer)。total は3種類の合計です。

DiffTotals ​

数えた自分のコミットで追加・削除した行数です。変更行数を参照してください。

フィールド型説明
commitsintegercommits で数えたコミットのうち、マージコミットでないもの
excludedintegerそのうち、変更がほかのコミットとして数えられるために行数の合計から除いたもの
commits_with_statsinteger残りの commits - excluded 件のうち、行数が分かっているもの
additions, deletionsinteger または nullcommits_with_stats 件のコミットだけの合計。coverage が unavailable のときは null
coveragestringno_commits、complete、partial、unavailable

coverage が unavailable のとき、additions と deletions は null になります。行数が分かっているコミットがないので、合計は 0 ではなく不明です。partial のときは一部のコミットだけの合計なので、使う前に coverage を確かめてください。

json
"diff_stats": {
  "commits": 42,
  "excluded": 6,
  "commits_with_stats": 30,
  "additions": 1830,
  "deletions": 612,
  "coverage": "partial"
}

Snapshot ​

フィールド説明
open_prs自分のプルリクエストのうち、最後に同期した時点でオープンだったもの
open_issues_authored自分が作成した Issue のうち、現在オープンなもの
threads期間内に活動のあったプルリクエストのレビュースレッド: total、open、resolved、outdated

RepoSummary ​

フィールド説明
repository_idリポジトリの GitHub node ID
full_nameowner/name(private リポジトリでは伏せます)
visibilitypublic、private、internal、unknown
owned自分が所有しているか(CLI リファレンスを参照)
accessible同期中に GitHub がリポジトリへのアクセスを拒否した(HTTP 403 または 404)ときは false。キャッシュ済みのデータは残します
summaryこのリポジトリの Summary

BucketSummary ​

フィールド説明
bucket.key暦の区切りの最初のローカルの日付(YYYY-MM-DD)
bucket.label2026-11-21(日)、2026-W47(ISO 週)、2026-11(月)
bucket.start, bucket.end区切りの正確な UTC の範囲。期間に合わせて切り詰めます
summaryこの区切りの Summary

CoverageSummary ​

フィールド説明
kindcommits、pull_requests、issues
status期間全体についての complete、partial、not_available、not_yet_synced、unknown
scopes何を取得したかを、人が読める説明で表したもの
segments期間を順に覆う {start, end, status, reason} の配列。reason は complete でない区間の理由で、それ以外は null

レポート全体のカバレッジが complete になるのは、すべての要素が complete のときだけです。--require-complete はこれを使います。

PrRow ​

フィールド説明
pr_idプルリクエストの GitHub node ID
repositoryowner/name
number, title, urlプルリクエストの番号、タイトル、URL
author作成者のログイン名(不明なときは unknown)
state現在の状態: open、closed、merged
is_draft現在のドラフトかどうか
created_at, merged_atタイムスタンプ(マージされていなければ merged_at は null)
events, events_by_subject期間内に数えた CI 以外のイベントの数。全員の分 / 自分の分
commits, reviews, comments, participants期間内の件数
discussion_participants期間内に会話コメント、インラインコメント、レビューサマリーのコメントを書いた、既知のアカウントの数(重複なし)
threads期間内にインラインコメントのあったレビュースレッド
last_activity期間内で最も新しいイベントの時刻(コミットは選んだ --commit-date を使います)
latest_cihead コミットの現在の CI の状態: success、failure、pending、neutral、skipped、cancelled、unknown、または null
diffPrDiff。分からないときは null

--sort の順(大きい順・新しい順)、次にリポジトリと番号の順に並びます。

PrDiff ​

最後に同期した時点での、プルリクエストの base と head の差分です。プルリクエストのスナップショットで、期間中に行った変更ではありません。プルリクエストの変更行数を参照してください。

フィールド説明
additions, deletions追加した行数と削除した行数(integer)
changed_files変更したファイルの数
observed_at差分を取得した時刻

Intensity ​

prs(プルリクエストの数)と、events_per_pr、reviews_per_pr、comments_per_pr、commits_per_pr、participants_per_pr、discussion_participants_per_pr、threads_per_pr、active_days_per_pr。後者はそれぞれ Stats オブジェクトで、プルリクエストがないときは null です。

TimingStats ​

time_to_first_review、creation_to_merge、review_to_next_author_activity、first_to_last_activity。それぞれ秒単位の Stats オブジェクトで、その値を持つプルリクエストがないときは null です。ライフサイクルの所要時間を参照してください。

Stats ​

count、min、median、mean、p90(nearest-rank 法による 90 パーセンタイル)、max。小数になることがあります。

ReviewRow ​

フィールド説明
event_id変わらないイベントの識別子
submitted_at提出した時刻
reviewerレビュアーのログイン名
stateAPPROVED、CHANGES_REQUESTED、COMMENTED、DISMISSED(元の状態が不明)、または null
repositoryowner/name
pr_idレビューしたプルリクエストの GitHub node ID、または null
pr_number, pr_titleプルリクエストの番号とタイトル(または null)
urlレビューへのリンク、または null

reviews_submitted には、数えた自分のレビューが入ります。reviews_received には、自分のプルリクエストにほかの人が提出したレビューが入ります。どちらも時刻の順です。

CommentRow ​

フィールド説明
event_id変わらないイベントの識別子
created_at作成した時刻
author作成者のログイン名
kindconversation_comment、inline_comment、review_summary
written_by_subject自分が書いたコメントなら true
repository, pr_numberコメントのある場所
pr_idプルリクエストの GitHub node ID、または null
editedコメントが編集されたか
urlリンク、または null

自分が書いたコメントと、自分のプルリクエストにほかの人が書いたコメントを、時刻の順に並べます。

IssueRow ​

フィールド説明
issue_idGitHub node ID
repository, number, title, urlIssue
is_open現在の状態
opened_in_period期間内に自分が作成したか
closed_in_period, reopened_in_period期間内の自分によるクローズ / 再オープンのイベント

リポジトリと番号の順に並びます。

プルリクエストの詳細(ghusage pr) ​

フィールド説明
schema_version, account, timezoneレポートと同じ
pr_id, repository, number, title, urlプルリクエスト
author作成者のログイン名
state, is_draft現在の状態
created_at, merged_at, closed_atタイムスタンプ(該当しないときは null)
merged_byマージした人のログイン名。マージされていないか不明なときは null
latest_cihead コミットの現在の CI の状態(文字列)、または null
commits, removed_commits現在プルリクエストに含まれるコミット / フォースプッシュで取り除かれたコミット
reviewsReviewCounts
commentsCommentCounts
review_threadstotal、open、resolved、outdated(現在の状態)
participants数えた CI 以外のイベントがある既知のアカウントのログイン名。並べ替え済み
discussion_participants会話コメント、インラインコメント、レビューサマリーのコメントを書いた既知のアカウントのログイン名。並べ替え済み
commit_authors{author, commits} の配列。現在プルリクエストに含まれるコミットをコミットの作成者ごとに数えたもので、多い順に並びます
timingtime_to_first_review_secs、creation_to_merge_secs、review_to_next_author_activity_secs、first_to_last_activity_secs(integer または null)
diff最後に同期した時点の PrDiff。分からないときは null
timelineイベントの順に並べた TimelineEntry の配列(--event-type で絞り込みます)
coverageこのプルリクエストのデータのカバレッジの状態
synced_atプルリクエストを最後に取得した時刻
private_repositories_redactedレポートと同じ

TimelineEntry ​

フィールド説明
event_id変わらないイベントの識別子
occurred_at起きた時刻(コミットでは、push した時刻ではなくコミットの時刻)
observed_atghusage が取得した時刻
actor, actor_kindログイン名(不明なときは unknown)と、user、bot、organization、mannequin、unknown のいずれか
event_typeCLI リファレンスに挙げたイベントの種類のいずれか
label人が読めるイベント名
detail補足の情報(レビューの状態、短い SHA、ラベル、変更前のタイトル、CI のチェックと結果、"thread reply only, not counted as a review"、"edited"、"via merge"、"no longer present" といった注記)、または null
urlリンク、または null
removed_observed_at項目がなくなったことを確認した時刻、または null

同じ時刻のイベントは、プルリクエストの流れに沿った順(作成、コミット、フォースプッシュ、…、マージ、クローズ、再オープン)に並べます。

コミット(ghusage commit) ​

フィールド説明
schema_versionレポートと同じ
repository、sha、urlコミット(url は GitHub 上のページ。なければ null)
messageコミットメッセージの全文
author、committer{name, login, date}。git の名前、ひも付いた GitHub のログイン名、日時(それぞれ null のことがある)
parents親コミットの SHA
is_merge親コミットが 2 つ以上あるかどうか
statsfiles、additions、deletions、total
files{filename, previous_filename, status, additions, deletions, changes, patch_available} の配列。--patch を付けると、GitHub が diff を返したファイルには patch(unified diff)も付く
files_truncated一覧に載っていない変更ファイルがあるかどうか
sourcecache か github
fetched_atGitHub から取得した日時
private_repositories_redactedレポートと同じ

ghusage commit に CSV 出力はありません。

その他のコマンド ​

sync ​

ghusage sync --format json:

フィールド説明
statuscomplete または partial
commits_foundコミット検索とデフォルトブランチのコミット一覧で見つかったコミットの数(重複なし)。プルリクエストの中でだけ見つかったコミットは含みません
pull_requests_found, pull_requests_fetched, pull_requests_unchanged検索で見つかった / 取得した / 変更がないため取得を省いたプルリクエストの数
issues_found, issues_fetched, issues_unchanged検索で見つかった / 取得した / 変更がないため取得を省いた Issue の数
failures取得に失敗した、または一部しか取得できなかったプルリクエストや Issue の説明
coverage書き込んだカバレッジの記録: kind、start、end、status、scope、reason、recorded_at
apirequests、retries、rate_limit_waits、total_api_time_ms、bytes_received(--diff-stats の行数のリクエストも含む)
diff_stats--diff-stats を付けたときだけ入ります。commits(期間内の自分のマージでないコミットのうち、行数を合計に入れるもの)、already_known(キャッシュにすでにあり、取り直さなかったもの)、fetched(今回取得したもの)、unavailable(GitHub が返さず、不明のままのもの)

doctor ​

{"ok": true, "checks": [{"ok": true, "message": "..."}]}

auth status ​

authenticated、source、login、id、scopes(配列または null)、rate_limit(core_remaining、core_limit、core_reset、search_remaining、search_limit、graphql_remaining、graphql_limit、または null)。

cache status ​

path、file_size_bytes、schema_version、account、repositories、pull_requests、issues、events、last_sync(started_at、finished_at、status、message、または null)、coverage_last_30_days(CoverageSummary の配列)。

CSV ​

CSV の出力は、コマンドごとにヘッダー行付きの平らな表が1つです。不明な値は空のセルになり、ゼロは 0 と書きます。タイムスタンプは UTC の RFC 3339 形式です。真偽値は true / false です。自由記述のテキスト(タイトル、詳細)からは制御文字を取り除きます。また、先頭が =、+、-、@ のときは前に ' を付け、表計算ソフトが数式として評価しないようにします。

overview, daily, weekly, monthly, yearly ​

暦の区切りごとに1行です(overview は日ごとの行を出力します)。

text
period,start,end,commits,merge_commits,prs_created,prs_merged,merges_performed,prs_closed_without_merge,reviews_submitted,reviewed_prs,reviews_received,comments_written,comments_received,review_responses,pr_commits,issues_opened,issues_closed,active_prs,pr_internal_events,ci_passed,ci_failed,additions,deletions,line_count_commits,line_count_commits_known,line_count_commits_excluded,line_count_coverage,coverage

period は区切りのラベルです。reviews_submitted / reviews_received は合計、comments_written / comments_received は3種類すべての合計、coverage はその区切りのカバレッジをまとめたものです。行数の列は下で説明します。

repos ​

text
repository,visibility,owned,accessible,commits,prs_created,prs_merged,reviews_submitted,comments_written,issues_opened,active_prs,pr_internal_events,additions,deletions,line_count_commits,line_count_commits_known,line_count_commits_excluded,line_count_coverage,last_activity,period_coverage

行数の列 ​

列説明
additions, deletionsdiff_stats.additions と diff_stats.deletions。行数が分かっているコミットがないとき(unavailable)は空欄。partial のときは、行数が分かっているコミットだけの合計
line_count_commits行数を合計に入れるコミットの数:diff_stats.commits - diff_stats.excluded
line_count_commits_knownそのうち、行数が分かっているもの(diff_stats.commits_with_stats)
line_count_commits_excludedほかのコミットとして数えられるために除いたもの(diff_stats.excluded)
line_count_coverageno_commits、complete、partial、unavailable

prs の CSV には行数の列はありません。プルリクエストの差分は JSON で取得してください。

prs ​

text
repository,number,title,state,draft,author,created_at,merged_at,events,events_by_you,commits,reviews,comments,participants,discussion_participants,threads,last_activity,latest_ci,url,period_coverage

reviews ​

text
direction,submitted_at,reviewer,state,repository,pr_number,url,period_coverage

direction は submitted または received です。

comments ​

text
created_at,author,kind,written_by_you,repository,pr_number,edited,url,period_coverage

issues ​

text
repository,number,title,open,opened_in_period,closed_in_period,reopened_in_period,url,period_coverage

pr ​

プルリクエストのタイムラインを、イベントごとに1行で出力します。

text
occurred_at,actor,actor_kind,event_type,detail,removed_observed_at,url

period_coverage は、期間全体をまとめたカバレッジです。sync、doctor、auth status、cache status、tui には CSV 形式がなく、--format csv を指定すると終了コード 2 で失敗します。

text
error: --format csv is not available for this command; use table or json

private リポジトリ ​

--include-private を指定しないと、JSON と CSV の出力では、公開でない(private と internal の)リポジトリの情報を伏せます。数値はどちらでも同じです。

項目置き換え後
リポジトリ名<owner>/repo-<8 hex characters>。owner は、自分が所有するリポジトリでは自分のログイン名、それ以外では private です。後ろの部分はリポジトリ ID から作るので、実行するたびに変わることはありません
プルリクエストと Issue のタイトル[private]
プルリクエストと Issue の URL空文字列
レビュー、コメント、イベントの URL、リポジトリの URLnull
レビュースレッドのファイルパス、ラベル名とマイルストーン名、変更前のタイトル、CI のチェック名削除
カバレッジの理由と sync の失敗の説明に出てくるリポジトリ名[private repository](公開だと分かっていないリポジトリすべて)
公開だと分かっていないリポジトリの ghusage commitリポジトリは private/repo-<16 進数 8 文字>、url は null、メッセージは [private]、ファイルパスは [private]。旧パス、diff、git の名前は出さない

人のログイン名(自分の分もほかの人の分も)と GitHub node ID は伏せません。表形式の出力とターミナル UI は、自分にだけ表示されるものなので、常に実際の名前を表示します。