@@ -69,43 +69,44 @@ The binary will be installed in `/usr/local/bin` folder.
69
69
Usage
70
70
=====
71
71
72
- $ varuh -h
73
- usage: varuh [-h|--help] [-I|--init "<value>"] [-d|--decrypt "<value>"]
74
- [-C|--clone "<value>"] [-R|--remove "<value>"] [-U|--use-db
75
- "<value>"] [-E|--edit "<value>"] [-l|--list-entry "<value>"]
76
- [-x|--export "<value>"] [-f|--find "<value>" [-f|--find "<value>"
77
- ...]] [-e|--encrypt] [-A|--add] [-p|--path] [-a|--list-all]
78
- [-g|--genpass] [-s|--show] [-c|--copy] [-y|--assume-yes]
79
- [-v|--version]
80
-
81
- Password manager for the command line for Unix like operating
82
- systems
83
-
84
- Options:
85
-
86
- -h --help Print help information
87
- -I --init <path> Initialize a new database
88
- -d --decrypt <path> Decrypt password database
89
- -C --clone <id> Clone an entry with <id>
90
- -R --remove <id> Remove an entry with <id> or <id-range>
91
- -U --use-db <path> Set <path> as active database
92
- -E --edit <id> Edit entry by <id>
93
- -l --list-entry <id> List entry by <id>
94
- -x --export <filename> Export all entries to <filename>
95
- -f --find <t1> <t2> ... Search entries with terms
96
- -e --encrypt Encrypt the current database
97
- -A --add Add a new entry
98
- -p --path Show current database path
99
- -a --list-all List all entries in current database
100
- -g --genpass Generate a strong password (length: 12 - 16)
101
- -s --show Show passwords when listing entries
102
- -c --copy Copy password to clipboard
103
- -y --assume-yes Assume yes to actions requiring confirmation
104
- -v --version Show version information and exit
105
-
106
-
107
- AUTHORS
108
- Copyright (C) 2021 Anand B Pillai <abpillai@gmail.com>
72
+ $ varuh -h
73
+ usage: varuh [-h|--help] [-I|--init "<value>"] [-d|--decrypt "<value>"]
74
+ [-C|--clone "<value>"] [-R|--remove "<value>"] [-U|--use-db
75
+ "<value>"] [-E|--edit "<value>"] [-l|--list-entry "<value>"]
76
+ [-x|--export "<value>"] [-m|--migrate "<value>"] [-f|--find
77
+ "<value>" [-f|--find "<value>" ...]] [-e|--encrypt] [-A|--add]
78
+ [-p|--path] [-a|--list-all] [-g|--genpass] [-s|--show] [-c|--copy]
79
+ [-y|--assume-yes] [-v|--version]
80
+
81
+ Password manager for the command line for Unix like operating
82
+ systems
83
+
84
+ Options:
85
+
86
+ -h --help Print help information
87
+ -I --init <path> Initialize a new database
88
+ -d --decrypt <path> Decrypt password database
89
+ -C --clone <id> Clone an entry with <id>
90
+ -R --remove <id> Remove an entry with <id> or <id-range>
91
+ -U --use-db <path> Set <path> as active database
92
+ -E --edit <id> Edit entry by <id>
93
+ -l --list-entry <id> List entry by <id>
94
+ -x --export <filename> Export all entries to <filename>
95
+ -m --migrate <path> Migrate a database to latest schema
96
+ -f --find <t1> <t2> ... Search entries with terms
97
+ -e --encrypt Encrypt the current database
98
+ -A --add Add a new entry
99
+ -p --path Show current database path
100
+ -a --list-all List all entries in current database
101
+ -g --genpass Generate a strong password (length: 12 - 16)
102
+ -s --show Show passwords when listing entries
103
+ -c --copy Copy password to clipboard
104
+ -y --assume-yes Assume yes to actions requiring confirmation
105
+ -v --version Show version information and exit
106
+
107
+
108
+ AUTHORS
109
+ Copyright (C) 2022 Anand B Pillai <abpillai@gmail.com>
109
110
110
111
111
112
Encryption and Security
@@ -149,22 +150,24 @@ The password database is created and is active now. You can start adding entries
149
150
Username: mememe
150
151
Password (enter to generate new):
151
152
Generating password ...done
153
+ Tags (separated by space): testing test website
152
154
Notes: Website uses Nginx auth
153
155
Do you want to add custom fields [y/N]:
154
156
Created new entry with id: 1
155
157
156
158
You can now list the entry with one of the list options.
157
159
158
160
$ varuh -l 1
159
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
161
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
160
162
ID: 1
161
163
Title: My Website Login
162
164
User: mememe
163
165
URL: http://mywebsite.name
164
166
Password: ****************
167
+ Tags: testing test website
165
168
Notes: Website uses Nginx auth
166
169
Modified: 2021-21-09 23:12:35
167
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
170
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
168
171
169
172
## Add an entry with custom fields
170
173
@@ -175,6 +178,7 @@ From version 0.3 onwards, custom fields are supported.
175
178
URL: https://github.com/mydev/myproject
176
179
Username: mydev
177
180
Password (enter to generate new): ghp_ipQrStuVwxYz1a2b3cdEF10ghI689kLaMnOp
181
+ Tags (separated by space): token github
178
182
Notes: Never Expires
179
183
Do you want to add custom fields [y/N]: y
180
184
Field Name: Domain
@@ -190,12 +194,12 @@ From version 0.3 onwards, custom fields are supported.
190
194
User: mydev
191
195
URL: https://github.com/mydev/myproject
192
196
Password: ghp_ipQrStuVwxYz1a2b3cdEF10ghI689kLaMnOp
197
+ Tags: token github
193
198
Notes: Never Expires
194
199
Domain: github.com
195
200
Type: Auth Token
196
201
Modified: 2021-21-13 00:07:18
197
202
198
-
199
203
For more on listing see the [ Listing and Searching] ( #listing-and-searching ) section below.
200
204
201
205
## Edit an entry
@@ -208,22 +212,25 @@ For more on listing see the [Listing and Searching](#listing-and-searching) sect
208
212
Current Username: mememe
209
213
New Username: meblog
210
214
Current Password: lTzC2z9kRppnYsYl
211
- New Password ([y/Y] to generate new, enter will keep old one):
215
+ New Password ([y/Y] to generate new, enter will keep old one):
216
+ Current Tags: testing test website
217
+ New Tags:
212
218
Current Notes: Website uses Nginx auth
213
219
New Notes: Website uses Apache
214
220
Do you want to add custom fields [y/N]:
215
221
Updated entry.
216
222
217
223
$ varuh -l 1 -s
218
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
224
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
219
225
ID: 1
220
226
Title: My Blog Login
221
227
User: meblog
222
228
URL: http://myblog.name
223
229
Password: myblog123
230
+ Tags: testing test website
224
231
Notes: Website uses Apache
225
232
Modified: 2021-21-09 23:15:29
226
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
233
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
227
234
228
235
## Edit an entry with custom fields
229
236
@@ -242,7 +249,8 @@ When you edit an entry with custom fields, you get the option to change the name
242
249
New Notes:
243
250
Editing/deleting custom fields
244
251
Field Name: Domain
245
- New Field Name (Enter to keep, "x" to delete): x
252
+ New Field Name (Enter to keep, "x" to delete): x
253
+ Deleting field: Domain
246
254
Field Name: Type
247
255
New Field Name (Enter to keep, "x" to delete): Token Type
248
256
Field Value: Auth Token
@@ -257,6 +265,7 @@ When you edit an entry with custom fields, you get the option to change the name
257
265
User: mydev
258
266
URL: https://github.com/mydev/myproject
259
267
Password: ghp_ipQrStuVwxYz1a2b3cdEF10ghI689kLaMnOp
268
+ Tags: token github
260
269
Notes: Never Expires
261
270
Token Type: Auth Token
262
271
Modified: 2021-21-13 00:16:41
@@ -273,12 +282,12 @@ To clone (copy) an entry,
273
282
## Remove an entry
274
283
275
284
$ varuh -R 1
276
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
285
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
277
286
Title: My Website Login
278
287
User: mememe
279
288
URL: https://mywebsite.name
280
289
Modified: 2021-21-09 23:12:35
281
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
290
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
282
291
Please confirm removal [Y/n]:
283
292
Entry with id 1 was removed from the database
284
293
@@ -336,7 +345,25 @@ If you want to switch back to a previous database, you can use the `-U` option.
336
345
Password:
337
346
Decryption complete.
338
347
Switched active database successfully.
339
-
348
+
349
+ ## Database Migration
350
+
351
+ (New in version 0.4)
352
+
353
+ When new features are added - sometimes new fields would be required to be added in the database schema. To make sure your old databases work with the new features in such cases, the ` --migrate ` option can be used to migrate your existing databases.
354
+
355
+ $ ./varuh -m /home/anand/mypasswds
356
+ Password:
357
+ Decryption complete.
358
+ Migrating tables ...
359
+
360
+ Encryption complete.
361
+ Migration successful.
362
+
363
+ For migration you need to provide the database path - even for the active database. Once migrated, you can continue to use your database as before.
364
+
365
+ NOTE: It is suggested to make a backup copy of your current active database before migration.
366
+
340
367
## Manual encryption and decryption
341
368
342
369
You can manually encrypt the current database using the ` -e ` option.
@@ -360,15 +387,16 @@ Manually decrypt the database using `-d` option.
360
387
Now the database is active again and you can see the listings.
361
388
362
389
$ varuh -l 3
363
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
390
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
364
391
ID: 2
365
392
Title: My Blog Login
366
393
User: myblog.name
367
394
URL: http://meblog
368
395
Password: *********
396
+ Tags: test testing website
369
397
Notes: Website uses Apache
370
398
Modified: 2021-21-09 23:21:32
371
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
399
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
372
400
373
401
## Always on encryption
374
402
@@ -379,15 +407,16 @@ If the config param `encrypt_on` is set to `true` along with `auto_encrypt` (def
379
407
$ varuh -f my -s
380
408
Password:
381
409
Decryption complete.
382
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
410
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
383
411
ID: 2
384
412
Title: MY LOCAL BANK
385
413
User: banklogin
386
414
URL: https://my.localbank.com
387
415
Password: bankpass123
416
+ Tags: bank banking finance
388
417
Notes:
389
418
Modified: 2021-21-18 12:44:10
390
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
419
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
391
420
392
421
Encryption complete.
393
422
@@ -401,62 +430,62 @@ Listing and Searching
401
430
To list an entry using its id,
402
431
403
432
$ varuh -l 8
404
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
433
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
405
434
ID: 8
406
435
Title: Google account
407
436
User: anandpillai@alumni.iitm.ac.in
408
437
URL:
409
438
Password: ***********
410
439
Notes:
411
440
Modified: 2021-21-25 15:02:50
412
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
441
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
413
442
414
443
## To search an entry
415
444
416
445
An entry can be searched on its title, username, URL or notes. Search is case-insensitive.
417
446
418
447
$ varuh -f google
419
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
448
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
420
449
ID: 8
421
450
Title: Google account
422
451
User: anandpillai@alumni.iitm.ac.in
423
452
URL:
424
453
Password: **********
425
454
Notes:
426
455
Modified: 2021-21-25 15:02:50
427
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
456
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
428
457
ID: 9
429
458
Title: Google account
430
459
User: xyz@gmail.com
431
460
URL:
432
461
Password: ********
433
462
Notes:
434
463
Modified: 2021-21-25 15:05:36
435
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
464
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
436
465
ID: 10
437
466
Title: Google account
438
467
User: somethingaboutme@gmail.com
439
468
URL:
440
469
Password: ***********
441
470
Notes:
442
471
Modified: 2021-21-25 15:09:51
443
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
472
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
444
473
445
474
446
475
## To search using multiple terms
447
476
448
477
The ` -f ` option supports multiple terms, so you can specify this more than one time to narrow a search down to a specific entry.
449
478
450
479
$ varuh -f google -f anand
451
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
480
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
452
481
ID: 8
453
482
Title: Google account
454
483
User: anandpillai@alumni.iitm.ac.in
455
484
URL:
456
485
Password: **********
457
486
Notes:
458
487
Modified: 2021-21-25 15:02:50
459
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
488
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
460
489
461
490
$ varuh -f google -f priya
462
491
Entry for "google priya" not found
@@ -466,31 +495,31 @@ The `-f` option supports multiple terms, so you can specify this more than one t
466
495
To list all entries, use the option ` -a ` .
467
496
468
497
$ varuh -a
469
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
498
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
470
499
ID: 1
471
500
Title: My Bank #1
472
501
User: myusername1
473
502
URL: https://mysuperbank1.com
474
503
Password: ***********
475
504
Notes:
476
505
Modified: 2021-21-15 15:40:29
477
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
506
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
478
507
ID: 2
479
508
Title: My Digital Locker #1
480
509
User: mylockerusername
481
510
URL: https://mysuperlocker1.com
482
511
Password: **********
483
512
Notes:
484
513
Modified: 2021-21-18 12:44:10
485
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
514
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
486
515
ID: 3
487
516
Title: My Bank Login #2
488
517
User: mybankname2
489
518
URL: https://myaveragebank.com
490
519
Password: **********
491
520
Notes:
492
521
Modified: 2021-21-19 14:16:33
493
- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
522
+ >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
494
523
...
495
524
496
525
By default the listing is in ascending ID order. This can be changed in the configuration (see below).
@@ -588,7 +617,7 @@ The config file is named *config.json*. It looks as follows.
588
617
"encrypt_on": true,
589
618
"path": "/home/anand/.config/varuh/config.json",
590
619
"list_order": "id,asc",
591
- "delimiter": "+ ",
620
+ "delimiter": "> ",
592
621
"color": "default",
593
622
"bgcolor": "bgblack"
594
623
}
0 commit comments