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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
|
[![Logo](assets/logo.jpg)](https://github.com/orhun/gpg-tui)
[![GitHub Release](https://img.shields.io/github/v/release/orhun/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&logo=GitHub&logoColor=white)](https://github.com/orhun/gpg-tui/releases)
[![Crate Release](https://img.shields.io/crates/v/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&logo=Rust&logoColor=white)](https://crates.io/crates/gpg-tui/)
[![Coverage](https://img.shields.io/codecov/c/gh/orhun/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&logo=Codecov&logoColor=white)](https://codecov.io/gh/orhun/gpg-tui)
[![Continuous Integration](https://img.shields.io/github/actions/workflow/status/orhun/gpg-tui/ci.yml?branch=master&style=flat&labelColor=1d1d1d&color=424242&logo=GitHub%20Actions&logoColor=white)](https://github.com/orhun/gpg-tui/actions?query=workflow%3A%22Continuous+Integration%22)
[![Continuous Deployment](https://img.shields.io/github/actions/workflow/status/orhun/gpg-tui/cd.yml?style=flat&labelColor=1d1d1d&color=424242&logo=GitHub%20Actions&logoColor=white&label=deploy)](https://github.com/orhun/gpg-tui/actions?query=workflow%3A%22Continuous+Deployment%22)
[![Docker Builds](https://img.shields.io/github/actions/workflow/status/orhun/gpg-tui/docker.yml?style=flat&labelColor=1d1d1d&color=424242&label=docker&logo=Docker&logoColor=white)](https://hub.docker.com/r/orhunp/gpg-tui)
[![Documentation](https://img.shields.io/docsrs/gpg-tui?style=flat&labelColor=1d1d1d&color=424242&logo=Rust&logoColor=white)](https://docs.rs/gpg-tui/)
## About
**gpg-tui** is a [Terminal User Interface](https://en.wikipedia.org/wiki/Text-based_user_interface) for [GnuPG](https://gnupg.org/).
It aims to ease the key management operations such as listing/exporting/signing by providing an interface along with the command-line fallback for more complex operations. It is not trying to be a full-fledged interface for _all_ the features that [gpg](https://linux.die.net/man/1/gpg) provides but it tries to bring a more interactive approach to key management.
<details>
<summary><b>Demo</b></summary>
![](demo/gpg-tui-showcase.gif)
<pre>
<b>gpg-tui</b> --style <span style="color: #036A9BFF"><i>colored</i></span> --splash --homedir <span style="color: #036A9BFF"><i>/etc/pacman.d/gnupg</i></span>
</pre>
</details>
<details>
<summary>Table of Contents</summary>
- [About](#about)
- [Requirements](#requirements)
- [Installation](#installation)
- [Cargo](#cargo)
- [Arch Linux](#arch-linux)
- [Community](#community)
- [AUR](#aur)
- [Gentoo](#gentoo)
- [Homebrew](#homebrew)
- [Docker](#docker)
- [Docker Hub](#docker-hub)
- [Using the Dockerfile](#using-the-dockerfile)
- [FreeBSD](#freebsd)
- [Building from source](#building-from-source)
- [Binary releases](#binary-releases)
- [NetBSD](#netbsd)
- [Install using the package manager](#install-using-the-package-manager)
- [Building from source](#building-from-source-1)
- [Manually](#manually)
- [Building from source](#building-from-source-2)
- [Binary releases](#binary-releases-1)
- [Usage](#usage)
- [Configuration](#configuration)
- [Key Bindings](#key-bindings)
- [User Interface](#user-interface)
- [Key Management](#key-management)
- [Customization](#customization)
- [Approach](#approach)
- [Detail Levels](#detail-levels)
- [Key Information](#key-information)
- [User Information](#user-information)
- [Features](#features)
- [User Interface](#user-interface-1)
- [Scrolling](#scrolling)
- [Options Menu](#options-menu)
- [Copy / Paste](#copy--paste)
- [Selection Mode](#selection-mode)
- [Detailed View](#detailed-view)
- [Search](#search)
- [File explorer](#file-explorer)
- [Running commands](#running-commands)
- [Key Management](#key-management-1)
- [List](#list)
- [Export](#export)
- [Sign](#sign)
- [Edit](#edit)
- [Import/Receive](#importreceive)
- [Send](#send)
- [Generate](#generate)
- [Delete](#delete)
- [Refresh](#refresh)
- [Styling](#styling)
- [Colors](#colors)
- [Splash screen](#splash-screen)
- [Roadmap](#roadmap)
- [Platforms](#platforms)
- [Packaging](#packaging)
- [Command-Line Fallback](#command-line-fallback)
- [Key Management Only](#key-management-only)
- [Resources](#resources)
- [About the project](#about-the-project)
- [External links](#external-links)
- [In the media](#in-the-media)
- [Contact](#contact)
- [Funding](#funding)
- [License](#license)
- [Copyright](#copyright)
</details>
## Requirements
- [Rust](https://www.rust-lang.org/): `>=1.64.0`
- Core dependencies: `gnupg`, `gpgme>=1.12.0`, `libgpg-error`
- Other dependencies: `libxcb`
Pleases note that the name of these dependencies (packages) might change depending on the distribution/platform.([*](https://github.com/orhun/gpg-tui/issues/10))
For installing these dependencies:
- on Arch Linux, run `pacman -S gpgme libx11`
- on Debian/Ubuntu, run `apt-get install libgpgme-dev libx11-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev`
- on Fedora, run `dnf install gpgme-devel libX11-devel`
- on Void Linux, run `xbps-install -S gpgme-devel libxcb-devel libgpg-error-devel gnupg`
## Installation
<details>
<summary>Packaging status</summary>
[![Packaging status](https://repology.org/badge/vertical-allrepos/gpg-tui.svg)](https://repology.org/project/gpg-tui/versions)
</details>
### Cargo
**gpg-tui** is available on [crates.io](https://crates.io/crates/gpg-tui/):
```sh
cargo install gpg-tui
```
### Arch Linux
#### Community
**gpg-tui** can be installed from the [community repository](https://archlinux.org/packages/community/x86_64/gpg-tui/) using [Pacman](https://wiki.archlinux.org/title/Pacman):
```sh
pacman -S gpg-tui
```
#### AUR
**gpg-tui** is also available on [AUR](https://aur.archlinux.org/packages/?O=0&SeB=b&K=gpg-tui&outdated=&SB=n&SO=a&PP=50&do_Search=Go) and it can be installed with an [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers):
```sh
paru -S gpg-tui-git
```
Or if you prefer, you can clone the [AUR packages](https://aur.archlinux.org/packages/?O=0&SeB=b&K=gpg-tui&outdated=&SB=n&SO=a&PP=50&do_Search=Go) and compile them with [makepkg](https://wiki.archlinux.org/index.php/Makepkg):
```sh
# clone the AUR repository
git clone https://aur.archlinux.org/gpg-tui-git.git && cd gpg-tui-git/
# build the package
makepkg -si
```
### Gentoo
Available in [dm9pZCAq overlay](https://github.com/gentoo-mirror/dm9pZCAq)
```sh
eselect repository enable dm9pZCAq
emerge --sync dm9pZCAq
emerge app-crypt/gpg-tui::dm9pZCAq
```
### Homebrew
To install the [Homebrew package](https://formulae.brew.sh/formula/gpg-tui), run:
```sh
brew install gpg-tui
```
To update, run:
```sh
brew upgrade gpg-tui
```
### Docker
#### Docker Hub
See available [tags](https://hub.docker.com/r/orhunp/gpg-tui/tags).
```sh
docker pull orhunp/gpg-tui:[tag]
```
You can also use the following command for a quick launch:
```sh
docker run --rm -it -v "$HOME/.gnupg":/app/.gnupg --user 1000:1000 orhunp/gpg-tui --homedir /app/.gnupg
```
#### Using the Dockerfile
```sh
# clone the repository
git clone https://github.com/orhun/gpg-tui.git && cd gpg-tui/
# build the image
docker build -t gpg-tui .
# run the container
docker run -it gpg-tui
```
### FreeBSD
All required dependencies are automatically fetched and installed independently of the installation method chosen.
#### Building from source
```sh
# using a port
cd /usr/ports/security/gpg-tui
make install
```
```sh
# alternative method using portmaster
portmaster security/gpg-tui
```
#### Binary releases
```sh
# update repository catalogue (if outdated)
pkg update
# fetch and install the package
pkg install gpg-tui
```
### NetBSD
**gpg-tui** is available from the main [pkgsrc branch](https://pkgsrc.se/security/gpg-tui).
#### Install using the package manager
```sh
pkgin install gpg-tui
```
#### Building from source
```sh
cd /usr/pkgsrc/security/gpg-tui
make install
```
### Manually
#### Building from source
```sh
# clone the repository
git clone https://github.com/orhun/gpg-tui.git && cd gpg-tui/
# build and install
cargo install --root "$HOME/.cargo" --path .
```
#### Binary releases
See available [releases](https://github.com/orhun/gpg-tui/releases) that are automated by [Continuous Deployment](.github/workflows/cd.yml) workflow.
## Usage
```
gpg-tui [OPTIONS]
```
```
OPTIONS:
-a, --armor Enables ASCII armored output
--splash Shows the splash screen on startup
--config <path> Sets the configuration file [env: GPG_TUI_CONFIG=]
--homedir <dir> Sets the GnuPG home directory [env: GNUPGHOME=]
-o, --outdir <dir> Sets the output directory [env: OUTDIR=]
--outfile <path> Sets the template for the output file name [env: OUTFILE=]
[default: {type}_{query}.{ext}]
-d, --default-key <key> Sets the default key to sign with [env: DEFAULT_KEY=]
-t, --tick-rate <ms> Sets the tick rate of the terminal [env: TICK_RATE=] [default: 250]
-c, --color <color> Sets the accent color of the terminal [env: COLOR=] [default: gray]
-s, --style <style> Sets the style of the terminal [env: STYLE=] [default: plain]
[possible values: plain, colored]
-f, --file-explorer <app> Sets the utility for file selection [env: FILE_EXPLORER=] [default: xplr]
--detail-level <level> Sets the detail level for the keys [env: DETAIL_LEVEL=] [default: minimum]
[possible values: minimum, standard, full]
--select <option> Enables the selection mode [env: SELECT=]
[possible values: key_id, key_fpr, user_id, row1, row2]
-h, --help Print help information
-V, --version Print version information
```
## Configuration
It is possible to override the command line arguments with a configuration file.
See [gpg-tui.toml](config/gpg-tui.toml) for the default configuration values.
The configuration file can be specified via `--config` argument or `GPG_TUI_CONFIG` environment variable. Also, it can be placed to a location where **gpg-tui** looks for:
* `<config_dir>` `/` `gpg-tui.toml`
* `<config_dir>` `/` `gpg-tui/gpg-tui.toml`
* `<config_dir>` `/` `gpg-tui/config`
`<config_dir>` depends on the platform as shown in the following table:
|Platform | Value | Example |
| ------- | ------------------------------------- | -------------------------------- |
| Linux | `$XDG_CONFIG_HOME` or `$HOME`/.config | /home/alice/.config |
| macOS | `$HOME`/Library/Application Support | /Users/Alice/Library/Application Support |
| Windows | `{FOLDERID_RoamingAppData}` | C:\Users\Alice\AppData\Roaming |
## Key Bindings
### User Interface
| Key Binding | Action |
| -------------------- | ---------------------------- |
| `?` | show help |
| `o,space,enter` | show options |
| `hjkl,arrows,pgkeys` | navigate |
| `n` | switch to normal mode |
| `v` | switch to visual mode |
| `c` | switch to copy mode |
| `p,C-v` | paste from clipboard |
| `a` | toggle armored output |
| `1,2,3` | set detail level |
| `t,tab` | toggle detail (all/selected) |
| `` ` `` | toggle table margin |
| `m` | toggle table size |
| `C-s` | toggle style |
| `/` | search |
| `:` | run command |
| `r,f5` | refresh application |
| `q,C-c/d,escape` | quit application |
### Key Management
| Key Binding | Action |
| ------------- | ------------- |
| `x` | export key |
| `s` | sign key |
| `e` | edit key |
| `i` | import key(s) |
| `f` | receive key |
| `u` | send key |
| `g` | generate key |
| `d,backspace` | delete key |
| `C-r` | refresh keys |
### Customization
Key bindings can be overridden/customized via using `general.key_bindings` setting in the [configuration file](#configuration). For example,
```toml
key_bindings = [
{ keys = [ "?", "h", "f1" ], command = ":help" },
{ keys = [ "C-s",
|