Add dashboard / description page
This commit is contained in:
33
README.md
33
README.md
@@ -1,13 +1,14 @@
|
||||
# gh-threads
|
||||
|
||||
A read-only terminal UI for people receiving GitHub pull-request reviews. It
|
||||
shows open PRs, review threads with highlighted diff hunks and comment authors,
|
||||
reviewer/assignee state, and the latest commit's check rollup. Resolved threads
|
||||
start folded. GitHub suggestion blocks are shown as syntax-highlighted
|
||||
remove/add previews. Comments render GitHub Flavored Markdown, including quoted
|
||||
replies, inline and fenced code, lists and tasks, links, tables, emphasis,
|
||||
strikethrough, emoji, and GitHub alerts. The current PR is refreshed in the
|
||||
background.
|
||||
shows open PRs and a scrollable PR dashboard with the description, branches,
|
||||
review state, checks, people, labels, milestone, activity, change statistics,
|
||||
and thread totals. The thread viewer includes highlighted diff hunks and comment
|
||||
authors. Resolved threads start folded. GitHub suggestion blocks are shown as
|
||||
syntax-highlighted remove/add previews. Comments and PR descriptions render
|
||||
GitHub Flavored Markdown, including quoted replies, inline and fenced code,
|
||||
lists and tasks, links, tables, emphasis, strikethrough, emoji, and GitHub
|
||||
alerts. The current PR is refreshed in the background.
|
||||
|
||||
## Install and run
|
||||
|
||||
@@ -76,6 +77,7 @@ endpoint = "https://api.github.com/graphql"
|
||||
[display]
|
||||
fold_resolved = true
|
||||
thread_list_width_percent = 33 # 20-60
|
||||
dashboard_mode = "hotkey" # "hotkey" or "intermediate"
|
||||
|
||||
[paths]
|
||||
scroll = false
|
||||
@@ -91,25 +93,32 @@ within_status = "file" # "file" or "timestamp" (oldest first)
|
||||
Command-line flags override the configuration. `GH_REPO` overrides the
|
||||
configured repository when `--repo` is not provided. The corresponding flags
|
||||
include `--config`, `--theme`, `--poll`, `--fold-resolved`,
|
||||
`--thread-list-width`, `--path-scroll`, and `--path-scroll-interval`. Boolean
|
||||
settings can be disabled explicitly, for example `--path-scroll=false`.
|
||||
`--thread-list-width`, `--dashboard-mode`, `--path-scroll`, and
|
||||
`--path-scroll-interval`. Boolean settings can be disabled explicitly, for
|
||||
example `--path-scroll=false`.
|
||||
|
||||
With the default `dashboard_mode = "hotkey"`, opening a PR goes directly to its
|
||||
review threads and `d` opens the dashboard only when requested. Set
|
||||
`dashboard_mode = "intermediate"` to follow picker → dashboard → review
|
||||
threads instead.
|
||||
|
||||
## Keys
|
||||
|
||||
| Key | Action |
|
||||
| --- | --- |
|
||||
| `h` / `l` | Focus the thread list / thread detail |
|
||||
| `j` / `k` | Move between threads or scroll the focused detail |
|
||||
| `j` / `k` | Move between items or scroll the dashboard/focused detail |
|
||||
| `?` | Show contextual keybinding help |
|
||||
| `d` | Open the current pull request dashboard |
|
||||
| `/` | Fuzzy-search thread file paths |
|
||||
| `↑` / `↓` | Choose a fuzzy-search match |
|
||||
| `g` / `G` | First / last item |
|
||||
| `enter` / `l` | Open a PR |
|
||||
| `enter` / `l` | Open the selected PR dashboard or its review threads |
|
||||
| `enter` | Toggle the selected review thread |
|
||||
| `za` | Toggle the selected thread |
|
||||
| `ctrl-d` / `ctrl-u` | Scroll thread detail or page through lists |
|
||||
| `tab` | Hide or reveal the thread list |
|
||||
| `b` / `esc` | Return to the PR picker |
|
||||
| `b` / `esc` | Return to the previous screen |
|
||||
| `r` | Refresh now |
|
||||
| `q` | Quit |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user