nishiki/mpw
1
0
Fork 0
mirror of https://github.com/nishiki/manage-password.git synced 2025-02-21 10:20:05 +00:00
Code Issues Releases Activity

update README

Browse source
This commit is contained in:
Adrien Waksberg 2017-03-02 23:43:19 +01:00
parent 6b8dce2eff
commit ba745ccc0c
1 changed files with 67 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -3,7 +3,6 @@
[![Build Status](https://travis-ci.org/nishiki/manage-password.svg?branch=master)](https://travis-ci.org/nishiki/manage-password) [![Build Status](https://travis-ci.org/nishiki/manage-password.svg?branch=master)](https://travis-ci.org/nishiki/manage-password)
[![License](https://img.shields.io/badge/license-GPL--2.0-blue.svg)](https://github.com/nishiki/manage-password/blob/master/LICENSE) [![License](https://img.shields.io/badge/license-GPL--2.0-blue.svg)](https://github.com/nishiki/manage-password/blob/master/LICENSE)
mpw is a little software which stores your passwords in [GnuPG](http://www.gnupg.org/) encrypted files. mpw is a little software which stores your passwords in [GnuPG](http://www.gnupg.org/) encrypted files.
## Features ## Features
@ -11,6 +10,8 @@ mpw is a little software which stores your passwords in [GnuPG](http://www.gnupg
* generate OTP code * generate OTP code
* synchronize your passwords with SSH or FTP. * synchronize your passwords with SSH or FTP.
* copy your login, password or otp in clipboard * copy your login, password or otp in clipboard
* manage many wallets
* share a wallet with others GPG keys
## Install ## Install
@ -20,17 +21,28 @@ apt install ruby ruby-dev xclip
gem install mpw gem install mpw
``` ```
## How to use
### First steps
# How to use Initialize your first wallet:
A simple mpw usage:
``` ```
mpw config --init user@host.com mpw config --init user@host.com
```
Add your first item:
```
mpw add mpw add
mpw copy ```
mpw add
And list your items:
```
mpw list mpw list
``` ```
or search an item with
```
mpw list --pattern Da
mpw list --group bank
```
Output: Output:
``` ```
@ -47,3 +59,52 @@ Linux
2 | linuxfr.org | example | https | | | Da Linux French Site 2 | linuxfr.org | example | https | | | Da Linux French Site
``` ```
Copy a password, login or OTP code:
```
mpw copy -p linuxfr
```
Update an item:
```
mpw update -p linuxfr
```
Delete an item:
```
mpw delete -p linuxfr
```
### Manage wallets
List all available wallets:
```
mpw wallet --list
```
Create an other wallet:
```
mpw config --wallet work --init user@host.com
```
List all GPG keys in wallet:
```
mpw wallet --list-keys [--wallet NAME]
```
Share with an other GPG key:
```
mpw wallet --add-gpg-key test42@localhost.com
or
mpw wallet --add-gpg-key /path/to/file
```
Remove a GPG key:
```
mpw wallet --delete-gpg-key test42@localhost.com
```
Add synchronize:
```
mpw wallet --protocol ssh --host example.com --user test --path /remote/path --password
```