Skip to content

Commit f04a6ea

Browse files
author
Anand
committed
ref issue #30 - Updated README with tags and migration and a few other things
1 parent 791ba80 commit f04a6ea

File tree

1 file changed

+71
-42
lines changed

1 file changed

+71
-42
lines changed

README.md

Lines changed: 71 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -69,43 +69,44 @@ The binary will be installed in `/usr/local/bin` folder.
6969
Usage
7070
=====
7171

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 <[email protected]>
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 <[email protected]>
109110

110111

111112
Encryption and Security
@@ -149,6 +150,7 @@ The password database is created and is active now. You can start adding entries
149150
Username: mememe
150151
Password (enter to generate new):
151152
Generating password ...done
153+
Tags (separated by space): testing test website
152154
Notes: Website uses Nginx auth
153155
Do you want to add custom fields [y/N]:
154156
Created new entry with id: 1
@@ -162,6 +164,7 @@ You can now list the entry with one of the list options.
162164
User: mememe
163165
URL: http://mywebsite.name
164166
Password: ****************
167+
Tags: testing test website
165168
Notes: Website uses Nginx auth
166169
Modified: 2021-21-09 23:12:35
167170
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -175,6 +178,7 @@ From version 0.3 onwards, custom fields are supported.
175178
URL: https://github.com/mydev/myproject
176179
Username: mydev
177180
Password (enter to generate new): ghp_ipQrStuVwxYz1a2b3cdEF10ghI689kLaMnOp
181+
Tags (separated by space): token github
178182
Notes: Never Expires
179183
Do you want to add custom fields [y/N]: y
180184
Field Name: Domain
@@ -190,12 +194,12 @@ From version 0.3 onwards, custom fields are supported.
190194
User: mydev
191195
URL: https://github.com/mydev/myproject
192196
Password: ghp_ipQrStuVwxYz1a2b3cdEF10ghI689kLaMnOp
197+
Tags: token github
193198
Notes: Never Expires
194199
Domain: github.com
195200
Type: Auth Token
196201
Modified: 2021-21-13 00:07:18
197202

198-
199203
For more on listing see the [Listing and Searching](#listing-and-searching) section below.
200204

201205
## Edit an entry
@@ -208,7 +212,9 @@ For more on listing see the [Listing and Searching](#listing-and-searching) sect
208212
Current Username: mememe
209213
New Username: meblog
210214
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:
212218
Current Notes: Website uses Nginx auth
213219
New Notes: Website uses Apache
214220
Do you want to add custom fields [y/N]:
@@ -221,6 +227,7 @@ For more on listing see the [Listing and Searching](#listing-and-searching) sect
221227
User: meblog
222228
URL: http://myblog.name
223229
Password: myblog123
230+
Tags: testing test website
224231
Notes: Website uses Apache
225232
Modified: 2021-21-09 23:15:29
226233
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -242,7 +249,8 @@ When you edit an entry with custom fields, you get the option to change the name
242249
New Notes:
243250
Editing/deleting custom fields
244251
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
246254
Field Name: Type
247255
New Field Name (Enter to keep, "x" to delete): Token Type
248256
Field Value: Auth Token
@@ -257,6 +265,7 @@ When you edit an entry with custom fields, you get the option to change the name
257265
User: mydev
258266
URL: https://github.com/mydev/myproject
259267
Password: ghp_ipQrStuVwxYz1a2b3cdEF10ghI689kLaMnOp
268+
Tags: token github
260269
Notes: Never Expires
261270
Token Type: Auth Token
262271
Modified: 2021-21-13 00:16:41
@@ -336,7 +345,25 @@ If you want to switch back to a previous database, you can use the `-U` option.
336345
Password:
337346
Decryption complete.
338347
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+
340367
## Manual encryption and decryption
341368

342369
You can manually encrypt the current database using the `-e` option.
@@ -366,6 +393,7 @@ Now the database is active again and you can see the listings.
366393
User: myblog.name
367394
URL: http://meblog
368395
Password: *********
396+
Tags: test testing website
369397
Notes: Website uses Apache
370398
Modified: 2021-21-09 23:21:32
371399
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -385,6 +413,7 @@ If the config param `encrypt_on` is set to `true` along with `auto_encrypt` (def
385413
User: banklogin
386414
URL: https://my.localbank.com
387415
Password: bankpass123
416+
Tags: bank banking finance
388417
Notes:
389418
Modified: 2021-21-18 12:44:10
390419
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -588,7 +617,7 @@ The config file is named *config.json*. It looks as follows.
588617
"encrypt_on": true,
589618
"path": "/home/anand/.config/varuh/config.json",
590619
"list_order": "id,asc",
591-
"delimiter": "+",
620+
"delimiter": ">",
592621
"color": "default",
593622
"bgcolor": "bgblack"
594623
}

0 commit comments

Comments
 (0)