ターミナル UI
ghusage tui # last 30 days, syncing in the background
ghusage tui --since 90d
ghusage tui --offline # cache only
ghusage tui --owner my-org # start with a repository filterターミナル UI に表示する数値は CLI と同じです。どちらも同じコードで、ローカルのキャッシュから計算しています。UI はキャッシュだけを読み、ネットワークを待つことはありません。--offline を付けずに起動すると、最初の期間の同期をバックグラウンドで始め、同期が終わると自動で表示を読み込み直します。進み具合、エラー、最後に同期した時刻はステータスバーに表示します。
キャッシュが空の状態で初めて実行したときは、UI を開く前に一度だけ GitHub に接続し、自分のアカウントを確認します。キャッシュが空で --offline を指定した場合は、--user を指定しない限り失敗します。
グローバルオプションのうち、--since、--until、--timezone、--repo、--owner、--visibility、--ownership、--user、--public-only、--commit-date、--data-dir、--concurrency が使えます。JSON や CSV の出力と違い、UI では表形式の出力と同じようにプライベートリポジトリの名前を表示します。
画面
| キー | 画面 | 内容 |
|---|---|---|
1 | Dashboard | 全体を一目で確認できる画面。コミット、作成した PR とマージされた PR、送ったレビューと受けたレビュー、書いたコメント、作成した Issue、アクティブな日数。日ごとの活動量のグラフ。上位のリポジトリ。最近活動したプルリクエスト。期間のカバレッジ |
2 | Overview | 主な数値(コミット、作成した PR とマージされた PR、送ったレビューと受けたレビュー、書いたコメント、アクティブな PR、現在 open の PR、作成した Issue、アクティブな日数、追加した行数と削除した行数)、日ごとの活動量のグラフ、上位のリポジトリ |
3 | Daily | 1 日 1 行(新しい日が上)。コミット、PR、マージ、レビュー、受けたレビュー、コメント、PR のコミット、Issue、アクティブな PR、追加・削除した行数(+Lines、-Lines) |
| Day Detail | 日の行で Enter を押すと開く。その日の数値と、その日に起きたことをセクションに分けて表示する。セクションは活動、コミット、プルリクエスト、レビュー(送ったもの・受けたもの)、コメント(書いたもの・受けたもの)、Issue | |
4 | Repositories | リポジトリごとの活動。公開・非公開の区別と、所有(owned)か外部(external)か。追加・削除した行数(+Lines、-Lines)も含む |
| Repository Detail | リポジトリの行で Enter を押すと開く。そのリポジトリの期間中の数値と、プルリクエスト、コミット、Issue、レビュー、コメント、活動をセクションに分けて表示する | |
5 | Pull Requests | 期間中に活動したプルリクエスト。状態、タイトル、イベント、自分のイベント、コミット、レビュー、コメント、関わった人、最後の活動 |
| PR Detail | プルリクエストの行で Enter を押すと開く。状態、author、マージ、コミット、現在の変更行数、レビュー、コメント、レビュースレッド、最新の CI、参加者、所要時間、カバレッジ、URL と、そのプルリクエストのコミット一覧 | |
| PR Timeline | PR Detail で Enter を押すと開く。プルリクエストのすべてのイベントを順に並べる。イベントの分類で絞り込める | |
| Commit | コミットの行で Enter を押すと開く(PR Detail のコミット一覧、日やリポジトリの詳細画面の Commits セクション)。コミットの情報、メッセージ、変更ファイル、diff | |
6 | Reviews | 自分が送ったレビューと、自分のプルリクエストに付いたレビュー。Enter でレビュー対象のプルリクエストを開く |
7 | Issues | 期間中に自分が作成、クローズ、再オープンした Issue |
| Issue Detail | Issue の行で Enter を押すと開く。タイトル、リポジトリ、author、現在の状態、作成日時とクローズ日時、期間中の Issue のイベント | |
8 | System | アカウント、オンラインかオフラインか、認証情報の取得元、レート制限、最後の同期、このセッションで行った同期の結果、キャッシュの場所・サイズ・件数、データの種類ごとのカバレッジと抜け、警告とエラー |
2 行目には番号付きのタブを表示し、詳細画面ではそこまでたどった経路も表示します(たとえば › Day Detail › PR Detail)。幅の狭いターミナルではタブのタイトルを短くし、幅が約 75 桁より狭いと、今のタブだけにタイトルを残します。
ステータスバーには、データがキャッシュからのものであること、表示中のデータのカバレッジ、最後に同期した時刻、バックグラウンドの同期の進み具合やエラー、直前のキー操作に対するメッセージを表示します。幅の広いターミナルでは、今の画面の主なキーも表示します。
Dashboard と Overview のグラフの活動量は、1 日あたりの自分のコミット、プルリクエストの中での自分のイベント、自分の Issue のイベントの数です。
行数
追加・削除した行数は、CLI と同じ定義で計算します。
- Overview には、期間の Lines added と Lines deleted を表示します。
- Daily と Repositories には +Lines と -Lines の列があります。表形式の出力と同じく、
~Nは一部のコミットだけの合計、?は行数が分かっているコミットがないことを表します。足りない行数はghusage sync --diff-statsで取得できます。幅の狭いターミナルでは、Repositories はこれらの列を早めに隠します(既知の制約を参照)。 - PR Detail には Changes (now) を表示します。最後に同期した時点での、プルリクエストの base と head の差分です(
+A -D in F files (base to head as of <時刻>))。期間内の変更ではなく、スナップショットです。 - PR Detail のコミット一覧には、幅が 70 桁以上のターミナルで Lines 列(
+A -D、分からないときは?)を表示します。
行数は、生成されたファイル、整形だけの変更、依存関係の更新、ファイルの移動で大きく変わります。仕事の量や質を測るものではありません。
Dashboard
最初に開くのは Dashboard です。表示はターミナルの大きさに合わせて変わります。80×24 では、数値、カバレッジの行、グラフ、2 つのリストを横に並べて表示します。それより狭いターミナルではリストを縦に積み、場所が足りなければ、まずグラフを、次にリストを省きます(2 つのリストが収まらないときは、フォーカスのあるリストだけを表示します)。カバレッジの行は、期間について全種類のデータが complete なら ✓、そうでなければ ! で始まり、partial や not yet synced の種類を挙げます。
Tab で、数値、リポジトリのリスト、プルリクエストのリストの間でフォーカスを移します。リポジトリで Enter を押すとその Repository Detail を、プルリクエストで押すとその PR Detail を開きます。
日とリポジトリの詳細
日やリポジトリの詳細画面の上部にある数値は、開いたもとの Daily や Repositories の行の数値と同じです。Tab と Shift+Tab でセクションを切り替えます。各セクションの名前の横には、そのセクションの行数を表示します。各セクションの内容は次のとおりです。
- 活動(Activity): 自分のイベント(コミット、プルリクエストのイベント、レビュー、コメント、Issue のイベント)と、ほかの人が自分のプルリクエストに残したレビューとコメントを、新しい順に並べます。CI の結果は並べません。
(you)の付いた行が自分のものです。 - コミット(Commits): 自分のコミットを 1 件ずつ、新しい順に並べます。日付は
--commit-dateで選んだものを使います。 - プルリクエスト、レビュー、コメント、Issue(Pull requests、Reviews、Comments、Issues): その日やリポジトリについて、CLI の
prs、reviews、comments、issuesコマンドと同じ行を表示します。
Enter を押すと、選んだ行のプルリクエスト、Issue、コミットを開きます。t で時間範囲を変えたり f でリポジトリのフィルターを変えたりすると、日の詳細画面は閉じます。その日が新しい期間に含まれないことがあるためです。リポジトリと Issue の詳細画面は開いたままで、新しい期間に合わせて表示が変わります。
Issue Detail には、選んだ期間内の Issue のイベントだけを表示します。
PR Detail のコミット一覧
PR Detail では、プルリクエストの情報の下に、そのコミットを古い順に並べます。表示するのは、短い SHA、メッセージの 1 行目、作者、コミット日時、追加・削除した行数です。
- 以前はプルリクエストに含まれていたが今は含まれないコミット(force push の後など)も一覧に残り、暗い色で
removedと表示します。 - マージコミットには
mergeと表示します。 - 一覧の見出しには、コミットの数と、そのうち外れたものの数を出します。
- コミットメッセージは
syncのときに記録します。古い版で同期したプルリクエストでは、もう一度同期するまでメッセージの列が-になります。
Tab(または Shift+Tab)で、情報の欄とコミット一覧の間でフォーカスを移します。情報の欄にフォーカスがあるときは、これまでどおり Enter で PR Timeline、o でプルリクエストを開きます。コミット一覧にフォーカスがあるときの操作は次のとおりです。
j/k: コミットを選ぶ/: 一覧を検索する(SHA、メッセージ、作者)Enter: Commit 画面を開くo: GitHub でコミットを開く
Commit
Commit 画面には、次の内容を 1 ページにまとめて表示し、スクロールして読みます。
- リポジトリ、SHA、作者とコミッター(git の名前と GitHub のログイン名)、author date と committer date、親コミット(2 つ以上あれば
merge commitと表示)、変更されたファイル数と行数 - コミットメッセージの全文
- 変更ファイルの一覧。状態(
added、modified、removed、旧パス付きのrenamedなど)、追加・削除した行数、合計 - 全ファイルの diff。各ファイルは
── [n/total] status path (+added −removed)という見出しから始まります。追加した行は緑、削除した行は赤、hunk ヘッダー(@@ ... @@)はシアン、ファイルの見出しは黄色で表示します。+、-、@@の記号はそのまま残すので、色が見えなくても区別できます。
コミットは画面を開いたときに読み込みます。
- 前に開いたことがあればキャッシュから読みます。なければ GitHub から取得します(
GET /repos/{owner}/{repo}/commits/{sha}。ファイルが複数ページにわたるときは全ページ)。 - 取得は別スレッドで行うので、その間も画面は操作できます。読み込み中は、キャッシュにすでにある情報(SHA、メッセージの 1 行目、作者、日時、プルリクエストから外れたかどうか)と「Loading the commit」を表示し、ステータスバーに
⧗ loading commitを出します。 - 取得したコミットはキャッシュに保存するので、次からはオフラインでも表示できます。
表示できないときは、次のようになります。
--offlineのときや GitHub につながらないとき、キャッシュにないコミットは表示できず、「Not available offline」と表示します。- 読み込みに失敗したとき(force push の後にコミットが消えた、アクセスが拒否されたなど)は理由を表示します。
rでやり直すか、oで GitHub 上のページを開いてください。 --public-onlyのときは、公開されていないリポジトリのコミットを読み込みません。
GitHub は、バイナリファイルや大きすぎる diff を返しません。そのようなファイルには「no diff available from GitHub」と表示します。画面を軽く保つため、diff はファイルごとに 3000 行、コミット全体で 20000 行までしか表示せず、省いた行数を書き添えます(全体は o で GitHub で見られます)。描画するのは画面に見えている行だけなので、大きなコミットでもスクロールは速いままです。
| キー | 動作 |
|---|---|
j / Down、k / Up | 1 行スクロール |
PageDown / Space、PageUp | 1 画面スクロール |
g / Home、G / End | 先頭、末尾 |
] | 次のファイルの diff |
[ | 前のファイルの diff(最初のファイルで押すと先頭に戻る) |
o | GitHub でコミットを開く |
r | 失敗した後にもう一度読み込む(それ以外のときは、ほかの画面と同じく再読み込みと同期) |
Esc | 開いた元の画面に戻る |
ブロックの見出しには、表示している行と、いちばん上にあるのが何番目のファイルの diff か(file 2/5)を表示します。
キー操作
移動
| キー | 動作 |
|---|---|
1–8 | Dashboard、Overview、Daily、Repositories、Pull Requests、Reviews、Issues、System に切り替える |
j / Down | 次の行 |
k / Up | 前の行 |
PageDown / PageUp | 10 行移動する |
g / Home | 最初の行 |
G / End | 最後の行 |
Enter | 選んだ行の詳細を開く。Daily → Day Detail。Repositories(と Dashboard・Overview のリポジトリの欄)→ Repository Detail。Pull Requests(と Dashboard のプルリクエストの欄)→ PR Detail → PR Timeline(コミット一覧にフォーカスがあれば Commit)。Reviews → レビュー対象のプルリクエストの PR Detail。Issues → Issue Detail。日やリポジトリの詳細画面の行 → その PR Detail、Issue Detail、Commit |
Esc | 詳細画面では、開いたもとの画面に戻る。それ以外の画面では、今の検索を消す |
Tab / Shift+Tab | Dashboard: 数値、リポジトリ、プルリクエストの間でフォーカスを移す。Overview: 概要とリポジトリの欄を切り替える。Reviews: 送ったレビューと受けたレビューを切り替える。日とリポジトリの詳細画面: 次/前のセクション。PR Detail: 情報の欄とコミット一覧を切り替える。PR Timeline: 次/前のイベント分類のフィルター |
選択は最初の行と最後の行で止まり、反対側には回り込みません。
検索
| キー | 動作 |
|---|---|
/ | 今のリストの検索を始める(Daily、Repositories、Pull Requests、Reviews、Issues、日とリポジトリの詳細画面の各セクション、Issue Detail、PR Timeline、PR Detail のコミット一覧) |
| 任意の文字 | 検索文字列に加える。入力に合わせてリストを絞り込む(大文字と小文字は区別しない) |
Backspace | 最後の 1 文字を消す |
Up / Down | 検索中に選択を移す |
Enter | 検索結果を残したまま検索モードを抜ける |
Esc | 検索を消して検索モードを抜ける |
検索の対象は次のとおりです。
- Daily: 日付
- Repositories: リポジトリ名
- Pull Requests: タイトル、リポジトリ、
#number、author - Reviews: レビュアー、リポジトリ、プルリクエストのタイトル
- Issues: タイトル、リポジトリ、
#number - 日とリポジトリの詳細画面: 活動はアクター、イベント名、リポジトリ、タイトル。コミットは SHA とリポジトリ。コメントは author、リポジトリ、種類。プルリクエスト、レビュー、Issue はそれぞれのリストと同じ
- Issue Detail: アクターとイベント名
- PR Timeline: アクター、イベント名、詳細
- PR Detail のコミット一覧: SHA、メッセージ、作者
データと表示
| キー | 動作 |
|---|---|
r | キャッシュから読み込み直す。オンラインなら、今の期間の同期もバックグラウンドで始める(同時に実行する同期は 1 つだけ) |
t | 時間範囲を順に切り替える。起動時の範囲 → 今日 → 直近 7 日 → 直近 30 日 → 直近 90 日 → 今月 |
f | リポジトリのフィルターを順に切り替える。all → public → private → owned → external(コマンドラインで指定したフィルターに重ねて適用する) |
o | 選んだ項目(リポジトリ、プルリクエスト、レビュー、Issue、コミット、コメント、タイムラインのイベント)をブラウザーで開く |
? | ヘルプを表示する/隠す |
q / Ctrl+C | 終了する |
ヘルプの表示中は、? か Esc でヘルプを閉じ、q と Ctrl+C で終了します。ほかのキーは無視します。
t を押すと、キャッシュだけを使ってレポートの期間をすぐに切り替えます。新しい範囲が同期されていなければ、ステータスバーのカバレッジにそう表示されます。同期するには r を押してください。
PR Timeline のフィルター(Tab で切り替え)は、All、Commits、Reviews、Comments、Lifecycle、Coordination、Metadata、CI です。
リンクを開く
o で開くのは、検証を通った https://github.com の URL だけです。macOS では open、Linux では xdg-open、Windows では cmd /C start を使い、シェルのコマンド文字列は介しません。Windows では、シェルのメタ文字を含む URL は開きません。
補足
- バックグラウンドの同期中に終了すると、同期も止まります。それまでに書き込んだ分は残り、次の同期はそこから続けます。
- レポートはバックグラウンドで計算します。キャッシュが非常に大きい場合、期間やフィルターを変えたあとに初めて開いた画面には、しばらく「Computing…」と表示されます(ステータスバーには
⧗ computingと表示されます)。その間もほかの画面やキー操作は使えます。 - 20 桁 × 6 行より小さいターミナルでは「terminal too small」と表示します。
- ターミナル UI は macOS で動作を確かめています。Linux と Windows のターミナル(リンクを開く機能を含む)での動作は、まだ手作業では確認していません。