xonecas.io
725
Ds

diff-scope / files

diff-scope / README.md

1.1 KB
1# diff-scope
2
3A small terminal git diff viewer built with `cel-tui` and Bun.
4
5## Preview
6
7![diff-scope preview](./preview.png)
8
9## Current features
10
11- scrollable diff view
12- staged and unstaged diff snapshots
13- diff highlighting
14- wrapped long lines
15- status bar with current directory, branch, git status summary, and refresh mode
16- pending-change detection every 5 seconds
17- manual refresh with `r`
18- auto-refresh toggle with `Ctrl+R`
19- adjustable auto-refresh interval with `PageUp` / `PageDown`
20- help/about modal with `?`
21
22## Install locally
23
24Requires [Bun](https://bun.sh) and `git`.
25
26From this repo:
27
28```bash
29bun install
30bun link
31```
32
33Then run it inside any git repo:
34
35```bash
36cd /path/to/git/repo
37diff-scope
38```
39
40## Run
41
42```bash
43bun install
44bun run start
45```
46
47## Development
48
49```bash
50bun run dev
51bun run typecheck
52```
53
54## Current keybinds
55
56- `r` — refresh snapshot
57- `Ctrl+R` — toggle auto-refresh
58- `PageUp` — slow auto-refresh by 5 seconds
59- `PageDown` — speed auto-refresh up by 5 seconds
60- `?` — open or close help
61- `Esc` — close help
62- `Ctrl+Q` / `Ctrl+C` — quit