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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
[![Build Status](https://travis-ci.com/dandavison/delta.svg?branch=master)](https://travis-ci.com/dandavison/delta)
[![Gitter](https://badges.gitter.im/dandavison-delta/community.svg)](https://gitter.im/dandavison-delta/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## A syntax-highlighter for git and diff output
Delta provides language syntax-highlighting, within-line insertion/deletion detection, and restructured diff output for git on the command line. Here's what `git show` looks like when git is configured to use delta as its pager:
<br>
<table>
<tr>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/81058545-a5725f80-8e9c-11ea-912e-d21954586a44.png"
alt="image" />
</td>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/81058911-6abcf700-8e9d-11ea-93be-e212824ec03d.png"
alt="image" />
</td>
</tr>
<tr>
<td>
"Dracula" theme
</td>
<td>
"GitHub" theme
</td>
</tr>
</table>
<br>
<br>
**By default, delta restructures the git output slightly to make the hunk markers human-readable:**
<br>
<table><tr><td>
<img width=650px src="https://user-images.githubusercontent.com/52205/81059276-254cf980-8e9e-11ea-95c3-8b757a4c11b5.png" alt="image" />
</td></tr></table>
<br>
<br>
**All the syntax-highlighting color themes that are available with [bat](https://github.com/sharkdp/bat/) are available with delta:**
<br>
<table>
<tr>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/80850197-b8f5a000-8be8-11ea-8c9e-29c5b213c4b7.png"
alt="image" />
</td>
<td>
<img width=450px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/80850237-e04c6d00-8be8-11ea-9027-0d2ea62f15c2.png"
alt="image" />
</td>
</tr>
<tr>
<td>
<code>delta --list-themes --dark</code>
</td>
<td>
<code>delta --list-themes --light</code>
</td>
</tr>
</table>
<br>
## Features
| | delta | git | [diff-so-fancy] /<br>[diff-highlight] | github/gitlab |
|------------------------------------------------|-------|-----|---------------------------------------|---------------|
| language syntax highlighting | ✅ | ❌ | ❌ | ✅ |
| within-line insertion/deletion detection | ✅ | ❌ | ✅ | ✅ |
| multiple insertion/deletions detected per line | ✅ | ❌ | ❌ | ✅ |
| matching of unequal numbers of changed lines | ✅ | ❌ | ❌ | ❌ |
In addition, delta handles traditional unified diff output.
[diff-so-fancy]: https://github.com/so-fancy/diff-so-fancy
[diff-highlight]: https://github.com/git/git/tree/master/contrib/diff-highlight
## Installation
You can download an executable for your system: [Linux](https://github.com/dandavison/delta/releases/download/0.1.1/delta-0.1.1-x86_64-unknown-linux-musl.tar.gz) | [MacOS](https://github.com/dandavison/delta/releases/download/0.1.1/delta-0.1.1-x86_64-apple-darwin.tar.gz) | [Windows](https://github.com/dandavison/delta/releases/download/0.1.1/delta-0.1.1-x86_64-pc-windows-gnu.zip) | [All](https://github.com/dandavison/delta/releases)
Alternatively, delta is available in the following package managers:
<table>
<tr>
<td>Arch Linux (<a href="https://aur.archlinux.org/packages/git-delta">AUR</a>)</td>
<td><code>yay -S git-delta</code>
<br>or<br>
<code>git clone https://aur.archlinux.org/git-delta.git</code><br>
<code>cd git-delta</code><br>
<code>makepkg -csri</code></td>
</tr>
<tr>
<td>Debian</td>
<td><br>.deb files are on the <a href="https://github.com/dandavison/delta/releases">releases</a> page and at <a href="https://github.com/barnumbirr/delta-debian/releases">barnumbirr/delta-debian</a><br>
<code>dpkg -i file.deb</code></td>
</tr>
<tr>
<td>Fedora</td>
<td><code>dnf install git-delta</code></td>
</tr>
<tr>
<td>FreeBSD</td>
<td><code>pkg install git-delta</code></td>
</tr>
<tr>
<td>Homebrew</td>
<td><code>brew install git-delta</code></td>
</tr>
<tr>
<td>MacPorts</td>
<td><code>port install git-delta</code></td>
</tr>
<tr>
<td>Nix</td>
<td><code>nix-env -iA nixpkgs.gitAndTools.delta</code>
</tr>
<tr>
<td>Windows (<a href="https://chocolatey.org/packages/delta">Chocolatey</a>)</td>
<td><code>choco install delta</code></td>
</tr>
</table>
#### Configure git to use delta
Set delta to be git's pager in your `.gitconfig`. Delta accepts many command line options to alter colors and other details of the output. An example is
```
[core]
pager = delta --plus-color="#012800" --minus-color="#340001" --theme='Monokai Extended'
[interactive]
diffFilter = delta --color-only
```
Note that delta argument values in ~/.gitconfig should be in double quotes, like `--minus-color="#340001"`. For a theme name containing a space, use single quotes, like `--theme='Monokai Extended'`.
All git commands that display diff output should now display syntax-highlighted output. For example:
- `git diff`
- `git show`
- `git log -p`
- `git stash show -p`
- `git reflog -p`
- `git add -p`
Delta also handles unified diff output:
```
diff -u a.txt b.txt | delta
```
## Supported languages and themes
To list the supported languages and color themes, use `delta --list-languages` and `delta --list-theme-names`. To see a demo of the color themes, use `delta --list-themes`:
To add your own custom color theme, or language, please follow the instructions in the Customization section of the [bat documentation](https://github.com/sharkdp/bat/#customization):
- [Adding a custom language](https://github.com/sharkdp/bat/#adding-new-syntaxes--language-definitions)
- [Adding a custom theme](https://github.com/sharkdp/bat/#adding-new-themes)
Delta automatically recognizes custom themes and languages added to bat. You will need to install bat in order to run the `bat cache --build` command.
The languages and color themes that ship with delta are those that ship with bat. So, to propose a new language or color theme for inclusion in delta, it would need to be a helpful addition to bat, in which case please open a PR against bat.
## 24 bit color (truecolor)
Delta looks best if your terminal application supports 24 bit colors. See https://gist.github.com/XVilka/8346728. For example, on MacOS, iTerm2 supports 24-bit colors but Terminal.app does not.
If your terminal application does not support 24-bit color, delta will still work, by automatically choosing the closest color from those available. See the `Colors` section of the help output below.
If you're using tmux, it's worth checking that 24 bit color is working correctly. For example, run a color test script like [this one](https://gist.githubusercontent.com/lifepillar/09a44b8cf0f9397465614e622979107f/raw/24-bit-color.sh), or one of the others listed [here](https://gist.github.com/XVilka/8346728). If you do not see smooth color gradients, see the discussion at [tmux#696](https://github.com/tmux/tmux/issues/696). The short version is you need something like this in your `~/.tmux.conf`:
```
set -ga terminal-overrides ",xterm-256color:Tc"
```
and you may then need to quit tmux completely for it to take effect.
## Windows
Delta works with Windows. However, the `less.exe` installed with git doesn't work well with `delta`. A patched version of `less.exe` and instructions for installing can be found [here](https://github.com/lzybkr/less/releases/tag/fix_windows_vt).
## Mouse scrolling
If mouse scrolling is broken, try setting your `BAT_PAGER` environment variable to (at least) `less -R` .
See [issue #58](https://github.com/dandavison/delta/issues/58) and [bat README / "Using a different pager"](https://github.com/sharkdp/bat#using-a-different-pager).
## Using delta with Magit
Delta can be used when displaying diffs in the Magit git client: see [magit-delta](https://github.com/dandavison/magit-delta). Here's a screenshot:
<table><tr><td><img width=500px src="https://user-images.githubusercontent.com/52205/79934267-2acb2e00-8420-11ea-8bc4-546508fd3581.png" alt="image" /></td></tr></table>
## Mercurial
Add delta to the `[pager]` section of `.hgrc`, the same way as `~/.gitconfig`.
## Options
Here's the output of `delta --help`. To use these options, add them to the delta command line in your `.gitconfig` file.
```
USAGE:
delta [FLAGS] [OPTIONS]
FLAGS:
--color-only Do not alter the input in any way other than applying colors. Equivalent to
`--keep-plus-minus-markers --width variable --tabs 0 --commit-style plain --file-
style plain --hunk-style plain`.
--dark Use default colors appropriate for a dark terminal background. For more control,
see the other color options.
-h, --help Prints help information
--highlight-removed Apply syntax highlighting to removed lines. The default is to apply syntax
highlighting to unchanged and new lines only.
--keep-plus-minus-markers Prefix added/removed lines with a +/- character, respectively, exactly as git does.
The default behavior is to output a space character in place of these markers.
--light Use default colors appropriate for a light terminal background. For more control,
see the other color options.
--list-languages List supported languages and associated file extensions.
--list-theme-names List available syntax-highlighting color themes.
--list-themes List available syntax highlighting themes, each with an example of highlighted diff
output. If diff output is supplied on standard input then this will be used for the
demo. For example: `git show --color=always | delta --list-themes`.
--show-background-colors Show the command-line arguments (RGB hex codes) for the background colors that are
in effect. The hex codes are displayed with their associated background color. This
option can be combined with --light and --dark to view the background colors for
those modes. It can also be used to experiment with different RGB hex codes by
combining this option with --minus-color, --minus-emph-color, --plus-color, --plus-
emph-color.
-V, --version Prints version information
OPTIONS:
--commit-color <commit_color> Color for the commit section of git output. [default: yellow]
--commit-style <commit_style>
Formatting style for the commit section of git output. Options are: plain, box. [default: plain]
--file-color <file_color> Color for the file section of git output. [default: blue]
--file-style <file_style>
Formatting style for the file section of git output. Options are: plain, box, underline. [default:
underline]
--hunk-color <hunk_color> Color for the hunk-marker section of git output. [default: blue]
--hunk-style <hunk_style>
Formatting style for the hunk-marker section of git output. Options are: plain, box. [default: box]
--max-line-distance <max_line_distance>
The maximum distance between two lines for them to be inferred to be homologous. Homologous line pairs are
highlighted according to the deletion and insertion operations transforming one into the other. [default:
0.3]
--minus-color <minus_color> The background color to use for removed lines.
--minus-emph-color <minus_emph_color> The background color to use for emphasized sections of removed lines.
--paging <paging_mode>
Whether to use a pager when displaying output. Options are: auto, always, and never. The default pager is
`less`: this can be altered by setting the environment variables BAT_PAGER or PAGER (BAT_PAGER has
priority). [default: auto]
--plus-color <plus_color> The background color to use for added lines.
--plus-emph-color <plus_emph_color> The background color to use for emphasized sections of added lines.
--tabs <tab_width>
The number of spaces to replace tab characters with. Use --tabs=0 to pass tab characters through directly,
but note that in that case delta will calculate line widths assuming tabs occupy one character's width on
the screen: if your terminal renders tabs as more than than one character wide then delta's output will look
incorrect. [default: 4]
--theme <theme>
The code syntax highlighting theme to use. Use --theme=none to disable syntax highlighting. If the theme is
not set using this option, it will be taken from the BAT_THEME environment variable, if that contains a
valid theme name. Use --list-themes to view available themes. Note that the choice of theme only affects
code syntax highlighting. See --commit-color, --file-color, --hunk-color to configure the colors of other
parts of the diff output. [env: BAT_THEME=base16]
--24-bit-color <true_color>
Whether to emit 24-bit ("true color") RGB color codes. Options are auto, always, and never. "auto" means
that delta will emit 24-bit color codes iff the environment variable COLORTERM has the value "truecolor" or
"24bit". If your terminal application (the application you use to enter commands at a shell prompt) supports
24 bit colors, then it probably already sets this environment variable, in which case you don't need to do
anything. [default: auto]
-w, --width <width>
The width (in characters) of the background color highlighting. By default, the width is the current
terminal width. Use --width=variable to apply background colors to the end of each line, without right
padding to equal width.
Colors
------
All delta color options work the same way. There are three ways to specify a color:
1. RGB hex code
An example of using an RGB hex code is:
--file-color="#0e7c0e"
2. ANSI color name
There are 8 ANSI color names:
black, red, green, yellow, blue, magenta, cyan, white.
In addition, all of them have a bright form:
bright-black, bright-red, bright-green, bright-yellow, bright-blue, bright-magenta, bright-cyan, bright-white
An example of using an ANSI color name is:
--file-color="green"
Unlike RGB hex codes, ANSI color names are just names: you can choose the exact color that each
name corresponds to in the settings of your terminal application (the application you use to
enter commands at a shell prompt). This means that if you use ANSI color names, and you change
the color theme used by your terminal, then delta's colors will respond automatically, without
needing to change the delta command line.
"purple" is accepted as a synonym for "magenta". Color names and codes are case-insensitive.
3. ANSI color number
An example of using an ANSI color number is:
--file-color=28
There are 256 ANSI color numbers: 0-255. The first 16 are the same as the colors described in
the "ANSI color name" section above. See https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit.
Specifying colors like this is useful if your terminal only supports 256 colors (i.e. doesn't
support 24-bit color).
```
<br>
## Comparisons
(`delta --light`)
<table>
<tr>
<td>
delta vs. git
</td>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/65248525-32250480-daea-11e9-9965-1a05c6a4bdf4.png"
alt="image" />
</td>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/65248441-14f03600-daea-11e9-88a1-d96bbb6947f8.png"
alt="image" />
</td>
</tr>
<tr>
<td>
delta vs. diff-so-fancy /<br>diff-highlight
</td>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/65248525-32250480-daea-11e9-9965-1a05c6a4bdf4.png"
alt="image" />
</td>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/65248407-07d34700-daea-11e9-9a8f-6d81f4021abf.png"
alt="image" />
</td>
</tr>
<tr>
<td>
delta vs. github
</td>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/65248525-32250480-daea-11e9-9965-1a05c6a4bdf4.png"
alt="image" />
</td>
<td>
<img width=500px style="border: 1px solid black"
src="https://user-images.githubusercontent.com/52205/65248749-9a73e600-daea-11e9-9c0d-29c8f1dea08e.png"
alt="image" />
</td>
</tr>
</table>
## Build delta from source
You'll need to [install the rust tools](https://www.rust-lang.org/learn/get-started). Then:
```
cargo build --release
```
and use the executable found at `./target/release/delta`.
## Credit
https://github.com/trishume/syntect<br>
https://github.com/sharkdp/bat<br>
https://github.com/so-fancy/diff-so-fancy
|