aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 71d902fec3613ec42764192b0f8a76dfb0ada9e0 (plain)
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
# LockPassword
a simple terminal password manager, using GnuPG to encrypt passwords. Distributed under the GNU General Public License, version 3.

## Dependencies:
* GnuPG
* [GPGME](gnupg.org/software/gpgme/) - GnuPG high-level crypto API

### Optional:
* X11 environment

## Installation:
Run the next commands:
```
make
sudo make install
```

## Synopsis:
**lpass** *command* [*options*]

## Commands:
### init *gpg-key*
Initialize the password manager using the passed *gpg-key* as the encryption key. This command must be run first before you start working with LockPassword.
### insert [**-e, --echo**] [**-c, --copy**] [**-f, --force**] *passname*
Add the specified *passname* to the password manager. The password will be read interactively using standard input, character display is hidden. The **-e, --echo** argument enable the show of characters when typing a password; **-c, --copy** write password to clipboard; **-f, --force** ignore exist of *passname*, overwrites it without prompt.
### show [**-c, --copy**] [**-C, --no-color**] [*passname*]
If no *passname* is specified, *passname* will assign root of password manager tree. If *passname* is directory, list names of passwords inside the at *passname*. Otherwise decrypt and print a password of *passname*. The **-c, --copy** write password to clipboard; **-C, --no-color** cancel colorize the output.
### edit *passname*
Open the specified *passname* in a text editor, waiting for changes. The text editor specified in the environment variable EDITOR or vi(1) is used. Temporary file for password editing locate in tmpfs / ramfs (we expect that it to be mounted at /dev/shm).
### generate [**-l, --length=pass-length**] [**-c, --copy**] [**-f, --force**] *passname*
Generate a random password and write it in *passname*. The **-l, --length = pass-length** argument allow you to specify the desired password length. Without this argument, a 14 character password will be generated. **-c, --copy** write password to clipboard; **-f, --force** ignore exist of *passname*, overwrites it without prompt.
### mv [**-f, --force**] *old-path* *new-path*
Move/rename *old-path* to *new-path*. *old-path* must be an exist file, *new-path* can be a file/directory. The **-f, --force** argument ignore exist of *new-path* (if it's a file), overwrites it without prompt.
### rm *passname*
Remove the *passname* you specified from the password manager. If the directories where your *passname* was nested became empty after deletion, then they are also deleted.
### help
Print help information about commands and the application itself.
### version
Print information about the version, release date, and license of the application.

## Guide:
* Initialize the password manager:
```
$ lpass init joursoir@joursoir.net
LockPassword initialized for joursoir@joursoir.net
```
```
$ lpass init 3BC3B37774696574B0F1C7D47B411E35F4F03E49
LockPassword initialized for 3BC3B37774696574B0F1C7D47B411E35F4F03E49
```

* Add password in the password manager:
```
$ lpass insert games/chess/user
Please type your new password: [invisible input]
Please type your new password again: [invisible input]
Password added successfully for games/chess/user
```

* Print a list of exists password:
```
$ lpass show
Password Manager
|-- banks
|   |-- abankpro
|   |   `-- phone_number
|   `-- ubank
|       `-- phone_number
`-- games
    `-- chess
        |-- site.com
        `-- user
```

* Print a list of exists password in some directory:
```
$ lpass show banks
Password Manager/banks
|-- abankpro
|   `-- phone_number
`-- ubank
    `-- phone_number
```

* Show password:
```
$ lpass show games/iko/LordOfNight
helloitismypassword123
```

* Copy password to clipboard:
```
$ lpass show -c games/iko/LordOfNight
```

* Generate password:
```
$ lpass generate bank/sbank/phone_number
Generated password: NsNu:+^Re(cshW
Password added successfully for bank/sbank/phone_number
```