trotp 1.1.9

TUI TOTP generator
Documentation 
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

# TROTP

A CLI tool for managing TOTP accounts.
All accounts are stored in a local file that's encrypted with the provided password.
If you don't provide the -p argument it will expect the password on stdin.

Running `trotp` without any arguments will run the TUI interface.

[![Lint and Test](https://github.com/Krakaw/TOTP/actions/workflows/test.yml/badge.svg)](https://github.com/Krakaw/TOTP/actions/workflows/test.yml)

![](demo/demo.gif)

## Installation

```bash
cargo install trotp
```
## Usage

```bash
trotp --help
```

```
TUI TOTP generator

Usage: trotp [OPTIONS] [COMMAND]

Commands:
  add          Add a new account
  edit         Edit an existing account
  delete       Delete an account
  interactive  Run in interactive mode [default]
  check        Check an OTP
  dump         Dump the config file
  secret       Extract the TOTP Secret from a record
  serve        Start an HTTP Server
  help         Print this message or the help of the given subcommand(s)

Options:
  -p, --password <PASSWORD>        The encryption password
  -s, --sqlite-path <SQLITE_PATH>  The sqlite filename [default: .totp.sqlite3]
  -a, --auto-lock-key              Automatically set the table lock key
  -h, --help                       Print help
  -V, --version                    Print version
```

### Add accounts

    trotp -p password add -a AccountName -s SecretToken -u Username -p Password123 -n Note

### Delete an account

    trotp -p password delete -a AccountName

### Edit an account

    trotp -p password edit -i 1 -a NewAccountName -s NewTOTPSecret -p NewPassword -n NewNote -u NewUserName

### Check an OTP against a secret for a specific time within a range

    trotp -p password check -t TokenSecretKey -o 123456 -s 2022-06-03T08:35:00+02:00 -r 10  

### Start an HTTP REST server that will return an OTP from your accounts if a name is provided or generate one for a provided secret

    trotp -p password serve

    # Example using a secret for a once off TOTP
    curl localhost:8080/JBSWY3DPEHPK3PXP
    {"account_name":"Secret","code":"359962","expiry":11}

    curl localhost:8080/acc
    {"account_name":"Account 1","code":"783196","expiry":30}

## Key Bindings

### User Interface

#### Global Key Bindings
| Key Binding | Action                          |
|-------------|---------------------------------|
| `/`         | Switch to search/filter mode    |
| `Esc`       | Return to normal mode           |
| `Tab`       | Toggle between OTP table and detail view |
| `Down`      | Select next account             |
| `Up`        | Select previous account         |
| `Home`      | Jump to first account            |
| `End`       | Jump to last account             |
| `Enter`     | Copy OTP or selected detail to clipboard |
| `Ctrl-c`    | Exit                            |

#### Normal Mode
| Key Binding | Action                          |
|-------------|---------------------------------|
| `e`         | Edit account name (OTP table) or detail field (detail view) |
| `d`         | Delete selected account         |
| `q`         | Quit application                |
| `?`         | Show help modal                 |

#### Edit Modal
When editing a field, a modal appears with the current value pre-populated:
| Key Binding | Action                          |
|-------------|---------------------------------|
| `Enter`     | Save changes                    |
| `Esc`       | Cancel editing                  |
| `Backspace` | Delete character                |
| `Shift`     | Capital letters                 |
| `Ctrl-V`    | Paste text                      |

#### Help Modal
The help modal displays all available keyboard shortcuts:
| Key Binding | Action                          |
|-------------|---------------------------------|
| `Esc` or `?` | Close help modal                |
| `Up/Down`   | Scroll help text (page-based)   |
| `Home/End`  | Jump to top/bottom of help       |
| `PageUp/PageDown` | Scroll by page                |