Change name and prepare for push
This commit is contained in:
26
README.md
26
README.md
@@ -1,4 +1,4 @@
|
||||
# gh-threads
|
||||
# diple
|
||||
|
||||
A terminal UI for people receiving GitHub pull-request reviews. It
|
||||
shows open PRs and a scrollable PR dashboard with the description, branches,
|
||||
@@ -20,7 +20,7 @@ Requires Go 1.24+, Git 2.38+, and an authenticated GitHub CLI:
|
||||
```sh
|
||||
go install .
|
||||
gh auth login
|
||||
gh-threads
|
||||
diple
|
||||
```
|
||||
|
||||
To run directly from a source checkout instead:
|
||||
@@ -41,34 +41,38 @@ authenticated user and groups the results by repository. Use `--repo` to limit
|
||||
the picker to one repository:
|
||||
|
||||
```sh
|
||||
gh-threads --repo owner/repository
|
||||
diple --repo owner/repository
|
||||
```
|
||||
|
||||
With a repository selected, pass `--all` to include every open PR in that
|
||||
repository:
|
||||
|
||||
```sh
|
||||
gh-threads --repo owner/repository --all --poll 15s
|
||||
diple --repo owner/repository --all --poll 15s
|
||||
```
|
||||
|
||||
GitHub Enterprise Server can be used after authenticating that host:
|
||||
|
||||
```sh
|
||||
gh auth login --hostname github.example.com
|
||||
gh-threads --repo owner/repository \
|
||||
diple --repo owner/repository \
|
||||
--endpoint https://github.example.com/api/graphql
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The optional TOML configuration is loaded from
|
||||
`$GH_THREADS_CONFIG`, `$XDG_CONFIG_HOME/gh-threads/config.toml`, or the
|
||||
operating system's user configuration directory at `gh-threads/config.toml`.
|
||||
On Linux this is normally `~/.config/gh-threads/config.toml`. On macOS,
|
||||
`~/Library/Application Support/gh-threads/config.toml` is preferred, with
|
||||
`~/.config/gh-threads/config.toml` automatically used as a fallback when it
|
||||
`$DIPLE_CONFIG`, `$XDG_CONFIG_HOME/diple/config.toml`, or the operating
|
||||
system's user configuration directory at `diple/config.toml`.
|
||||
On Linux this is normally `~/.config/diple/config.toml`. On macOS,
|
||||
`~/Library/Application Support/diple/config.toml` is preferred, with
|
||||
`~/.config/diple/config.toml` automatically used as a fallback when it
|
||||
exists.
|
||||
|
||||
For migration, `GH_THREADS_CONFIG` and existing `gh-threads` configuration or
|
||||
cache directories remain fallback locations when their new `diple`
|
||||
counterparts do not yet exist.
|
||||
|
||||
```toml
|
||||
theme = "dark" # dark, light, high-contrast, or no-color
|
||||
refresh_interval = "10s"
|
||||
@@ -221,7 +225,7 @@ avoid synchronized clients. Opening another PR or starting another refresh
|
||||
cancels the superseded request.
|
||||
|
||||
GitHub's public APIs report whether a PR conflicts but do not expose its
|
||||
conflicting file paths. For conflicting PRs only, `gh-threads` performs a
|
||||
conflicting file paths. For conflicting PRs only, `diple` performs a
|
||||
read-only `git merge-tree` analysis in a temporary bare repository. It never
|
||||
touches or inspects the current checkout, so Git, Jujutsu (`jj`), and directories
|
||||
without a local repository behave identically. The analysis fetches the exact
|
||||
|
||||
Reference in New Issue
Block a user