Skip to content

Commit ec5b88b

Browse files
author
Anand
committed
ref issue #9 - Updated usage on README.md
1 parent bd05925 commit ec5b88b

File tree

1 file changed

+41
-47
lines changed

1 file changed

+41
-47
lines changed

README.md

+41-47
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,15 @@ should work.
5050

5151
Then,
5252

53-
$ make
54-
go: downloading github.com/kirsle/configdir v0.0.0-20170128060238-e45d2f54772f
55-
go: downloading github.com/pborman/getopt/v2 v2.1.0
56-
go: downloading golang.org/x/crypto v0.0.0-20210921155107-089bfa567519
57-
go: downloading gorm.io/driver/sqlite v1.2.3
58-
...
53+
$ make
54+
Building varuh
55+
go: downloading github.com/akamensky/argparse v1.3.1
56+
go: downloading golang.org/x/crypto v0.0.0-20210921155107-089bfa567519
57+
go: downloading github.com/atotto/clipboard v0.1.4
58+
go: downloading github.com/kirsle/configdir v0.0.0-20170128060238-e45d2f54772f
59+
go: downloading github.com/pythonhacker/argparse v1.3.2
60+
go: downloading gorm.io/driver/sqlite v1.2.3
61+
...
5962

6063
$ sudo make install
6164
Installing varuh...done
@@ -66,53 +69,44 @@ The binary will be installed in `/usr/local/bin` folder.
6669
Usage
6770
=====
6871

69-
$ varuh -h
70-
71-
72-
SYNOPSIS
73-
74-
varuh [options] [flags]
75-
76-
OPTIONS
77-
78-
EDIT/CREATE ACTIONS:
79-
80-
-A --add Add a new entry
81-
-I --init <path> Initialize a new database
82-
-R --remove <id> Remove an entry
83-
-e --encrypt Encrypt the current database
84-
-d --decrypt <path> Decrypt password database
85-
-C --clone <id> Clone an entry
86-
-U --use-db <path> Set as active database
87-
-E --edit <id> Edit entry by id
88-
89-
FIND/LIST ACTIONS:
90-
91-
-f --find <term> Search entries
92-
-l --list-entry <id> List entry by id
93-
-x --export <filename> Export all entries to <filename>
94-
-p --path Show current database path
95-
-a --list-all List all entries in current database
96-
97-
MISC ACTIONS:
98-
99-
-g --genpass <length> Generate password of given length
100-
101-
HELP ACTIONS:
102-
103-
-h --help Print this help message and exit
104-
-v --version Show version information and exit
105-
106-
FLAGS:
107-
108-
-s --show Show passwords when listing entries
109-
-c --copy Copy password to clipboard
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>"] [-f|--find "<value>"] [-E|--edit "<value>"]
76+
[-l|--list-entry "<value>"] [-x|--export "<value>"] [-g|--genpass
77+
"<value>"] [-e|--encrypt] [-A|--add] [-p|--path] [-a|--list-all]
78+
[-s|--show] [-c|--copy] [-v|--version]
79+
80+
Password manager for the command line for Unix like operating
81+
systems
82+
83+
Options:
84+
85+
-h --help Print help information
86+
-I --init <path> Initialize a new database
87+
-d --decrypt <path> Decrypt password database
88+
-C --clone <id> Clone an entry with <id>
89+
-R --remove <id> Remove an entry with <id>
90+
-U --use-db <path> Set <path> as active database
91+
-f --find <term> Search entries with <term>
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+
-g --genpass <length> Generate password of given <length>
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+
-s --show Show passwords when listing entries
101+
-c --copy Copy password to clipboard
102+
-v --version Show version information and exit
110103

111104

112105
AUTHORS
113106
Copyright (C) 2021 Anand B Pillai <[email protected]>
114107

115108

109+
116110
The command line flags are grouped into `Edit/Create`, `Find/List`, `Misc` and `Help` actions. The first group of actions allows you to work with password databases and perform create/edit as well as encrypt/decrypt actions. The second set of actions allows you to work with an active decrypted database and view/search/list entries.
117111

118112
Encryption and Security

0 commit comments

Comments
 (0)