diff-tui 0.1.1

A terminal-based Git diff viewer with fuzzy search
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

# diff-tui

A terminal-based Git diff viewer. Provides an intuitive interface for browsing changed files and viewing diffs.

## Features

- **File Selection**: Browse changed files in your Git repository
- **Fuzzy Search**: Press `/` to filter files by name
- **Colored Diff**: Uses delta or git diff for syntax-highlighted diffs
- **Status Indicators**: M(modified), A(added), D(deleted), R(renamed), ?(untracked)

## Requirements

- Rust 1.70+
- Git

### Optional

- [delta](https://github.com/dandavison/delta) - Enhanced diff output (falls back to git diff if not installed)

## Installation

From crates.io:

```bash
cargo install diff-tui
```

From source:

```bash
git clone https://github.com/chouxcreams/diff-tui
cd diff-tui
cargo install --path .
```

## Configuration

Create `~/.config/diff-tui/config.toml` to customize settings:

```toml
[diff]
# Diff tool to use (default: "auto")
# Options: "auto", "delta", "diff-so-fancy", "difftastic", "colordiff", "git"
# Or specify any custom command name
tool = "delta"

# Additional arguments to pass to the diff tool (optional)
args = ["--side-by-side"]

[editor]
# Editor command (default: $EDITOR environment variable, then "vi")
command = "nvim"

# Additional arguments to pass to the editor (optional)
args = []
```

### Diff Tool Behavior

| Value | Behavior |
|-------|----------|
| `"auto"` | Try delta first, fall back to git diff (default) |
| `"delta"` | Use delta (falls back to git diff if not installed) |
| `"git"` | Use git diff directly |
| Other | Use specified command (falls back to git diff if not found) |

## Usage

Run inside a Git repository:

```bash
diff-tui
```

### Key Bindings

#### File Selection

| Key | Action |
|-----|--------|
| `j` / `↓` | Move to next file |
| `k` / `↑` | Move to previous file |
| `Enter` | View diff of selected file |
| `e` | Open file in editor |
| `/` | Start search mode |
| `q` | Quit |

#### Search Mode

| Key | Action |
|-----|--------|
| Type | Add to search query |
| `Backspace` | Delete character |
| `Enter` | View diff of selected file |
| `Esc` | Cancel search |
| `↑` / `↓` | Navigate search results |

#### Diff View

| Key | Action |
|-----|--------|
| `j` / `↓` | Scroll down 1 line |
| `k` / `↑` | Scroll up 1 line |
| `d` / `PageDown` | Scroll down 20 lines |
| `u` / `PageUp` | Scroll up 20 lines |
| `g` / `Home` | Go to top |
| `G` / `End` | Go to bottom |
| `e` | Open file in editor |
| `Esc` | Return to file selection |
| `q` | Quit |

## Tech Stack

- [Ratatui](https://ratatui.rs/) - TUI framework
- [git2](https://crates.io/crates/git2) - Git operations
- [nucleo](https://crates.io/crates/nucleo) - Fuzzy matching
- [ansi-to-tui](https://crates.io/crates/ansi-to-tui) - ANSI escape sequence parsing

## License

MIT