diffshot 1.0.2

A tool to generate images from git diffs
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

# diffshot

Turn git diffs into beautiful, shareable images - straight from your terminal.

**[Installation](#installation) · [Updating](#updating) · [Usage](#usage) · [Options](#options) · [Examples](#examples) · [Contact](#contact) · [License](#license)**

<img src="examples/diffshot.png" width="650" />

*Example output from running diffshot on a real git diff.*

## Installation

**macOS / Linux**
```bash
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/faisalfakih/diffshot/releases/latest/download/diffshot-installer.sh | sh
```

**Windows (PowerShell)**
```powershell
powershell -c "irm https://github.com/faisalfakih/diffshot/releases/latest/download/diffshot-installer.ps1 | iex"
```

**Via cargo**
```bash
cargo install diffshot
```

## Updating

**If installed via the install script (macOS/Linux/Windows)**
```bash
diffshot-update
```

**If installed via cargo**
```bash
cargo install diffshot --force
```

## Usage

```bash
diffshot [TARGET] [OPTIONS]
```

`TARGET` is an optional git ref or range. If omitted, diffshot renders your current uncommitted changes.

```bash
# Uncommitted changes
diffshot

# Diff between two branches
diffshot main..feat/auth

# Last 3 commits
diffshot HEAD~3
```

## Options

| Flag | Short | Description |
|------|-------|-------------|
| `--file <FILE>` | `-f` | Restrict the diff to a specific file |
| `--output <FILE>` | `-o` | Output filename. Extension sets the format: `png`, `jpg`, `jpeg`, `svg` (default: `diffshot.png`) |
| `--dir <DIR>` | `-d` | Directory to write output into (default: current directory) |
| `--max-lines <N>` | `-l` | Truncate the entire diff at N total lines |
| `--max-lines-per-chunk <N>` | `-L` | Truncate each `@@` chunk/hunk independently at N lines (shows a footer per truncated chunk) |
| `--resolution <N>` | `-r` | Pixel scale multiplier for output resolution (default: `2`) |
| `--split` | `-s` | Render each changed file as a separate image |
| `--no-highlight` | | Disable syntax highlighting |
| `--compact` | | Render all hunks of a file in one block (default: each chunk gets its own block) |
| `--relative` | | Show paths relative to the current directory instead of the repo root |

## Examples

```bash
# Diff of a specific file vs main
diffshot main --file src/main.rs

# Save as SVG into an exports folder
diffshot HEAD~1 --output diff.svg --dir exports/

# High-res PNG, split per file
diffshot main..dev --split --resolution 3

# Cap at 100 lines, no syntax highlighting
diffshot --max-lines 100 --no-highlight

# Cap each chunk at 50 lines (each @@ hunk gets its own truncation footer)
diffshot --max-lines-per-chunk 50
```

## Contact

[me@faisalfakih.com](mailto:me@faisalfakih.com)

## License

MIT © [Faisal Fakih](https://github.com/faisalfakih)