1
0
Fork 0
mirror of https://github.com/nishiki/manage-password.git synced 2025-02-20 01:50:04 +00:00

update readme

This commit is contained in:
nishiki 2016-05-16 21:39:05 +02:00
parent d7c8aa3142
commit 6ca9e8bffe

123
README.md
View file

@ -13,81 +13,88 @@ This program work with ruby >= 2.0
# How to use # How to use
* Show help * Show help
> mpw --help mpw --help
* Setup a new config file * Setup a new config file
> mpw --setup mpw --setup
> mpw --setup --config /path/conf/file.cfg mpw --setup --config /path/conf/file.cfg
* Create and setup a new wallet * Create and setup a new wallet
> mpw --setup-wallet --wallet new_wallet_name mpw --setup-wallet --wallet new_wallet_name
> mpw --setup-wallet --wallet new_wallet_name --config /path/conf/file.cfg mpw --setup-wallet --wallet new_wallet_name --config /path/conf/file.cfg
* Add a new item in wallet * Add a new item in wallet
```
> mpw --add mpw --add
> mpw --add --config /path/conf/file.cfg mpw --add --config /path/conf/file.cfg
> mpw --add --wallet wallet_name mpw --add --wallet wallet_name
> mpw --add --config /path/conf/file.cfg --wallet wallet_name mpw --add --config /path/conf/file.cfg --wallet wallet_name
```
* Update an item * Update an item
```
> mpw --update --id uniq_id mpw --update --id uniq_id
> mpw --update --id uniq_id --config /path/conf/file.cfg mpw --update --id uniq_id --config /path/conf/file.cfg
> mpw --update --id uniq_id --wallet wallet_name mpw --update --id uniq_id --wallet wallet_name
> mpw --update --id uniq_id --config /path/conf/file.cfg --wallet wallet_name mpw --update --id uniq_id --config /path/conf/file.cfg --wallet wallet_name
```
* Delete an item * Delete an item
```
> mpw --delete --id uniq_id mpw --delete --id uniq_id
> mpw --delete --id uniq_id --config /path/conf/file.cfg mpw --delete --id uniq_id --config /path/conf/file.cfg
> mpw --delete --id uniq_id --wallet wallet_name mpw --delete --id uniq_id --wallet wallet_name
> mpw --delete --id uniq_id --config /path/conf/file.cfg --wallet wallet_name mpw --delete --id uniq_id --config /path/conf/file.cfg --wallet wallet_name
```
* Show an item * Show an item
```
> mpw --show 'string to search' mpw --show 'string to search'
> mpw --show 'string to search' --config /path/conf/file.cfg mpw --show 'string to search' --config /path/conf/file.cfg
> mpw --show 'string to search' --wallet wallet_name mpw --show 'string to search' --wallet wallet_name
> mpw --show 'string to search' --config /path/conf/file.cfg --wallet wallet_name mpw --show 'string to search' --config /path/conf/file.cfg --wallet wallet_name
> mpw --show 'string to search' --group group_name mpw --show 'string to search' --group group_name
> mpw --show 'string to search' --group group_name --config /path/conf/file.cfg mpw --show 'string to search' --group group_name --config /path/conf/file.cfg
> mpw --show 'string to search' --group group_name --wallet wallet_name mpw --show 'string to search' --group group_name --wallet wallet_name
> mpw --show 'string to search' --group group_name --config /path/conf/file.cfg --wallet wallet_name mpw --show 'string to search' --group group_name --config /path/conf/file.cfg --wallet wallet_name
```
* Export data in YAML file * Export data in YAML file
```
> mpw --export --file /path/file/to/export.yml mpw --export --file /path/file/to/export.yml
> mpw --export --file /path/file/to/export.yml --config /path/conf/file.cfg mpw --export --file /path/file/to/export.yml --config /path/conf/file.cfg
> mpw --export --file /path/file/to/export.yml --wallet wallet_name mpw --export --file /path/file/to/export.yml --wallet wallet_name
> mpw --export --file /path/file/to/export.yml --config /path/conf/file.cfg --wallet wallet_name mpw --export --file /path/file/to/export.yml --config /path/conf/file.cfg --wallet wallet_name
```
* Import data from YAML file * Import data from YAML file
```
> mpw --import --file /path/file/to/export.yml mpw --import --file /path/file/to/export.yml
> mpw --import --file /path/file/to/export.yml --config /path/conf/file.cfg mpw --import --file /path/file/to/export.yml --config /path/conf/file.cfg
> mpw --import --file /path/file/to/export.yml --wallet wallet_name mpw --import --file /path/file/to/export.yml --wallet wallet_name
> mpw --import --file /path/file/to/export.yml --config /path/conf/file.cfg --wallet wallet_name mpw --import --file /path/file/to/export.yml --config /path/conf/file.cfg --wallet wallet_name
```
Format file to import: Format file to import:
```
> 1: 1:
> name: Website perso name: Website perso
> group: Perso group: Perso
> host: localhost.local host: localhost.local
> protocol: ftp protocol: ftp
> user: test user: test
> password: letoortue password: letoortue
> port: 21 port: 21
> comment: Mysuper website comment: Mysuper website
> 2: 2:
> name: Linuxfr name: Linuxfr
> group: Pro group: Pro
> host: Linuxfr.org host: Linuxfr.org
> protocol: https protocol: https
> user: test user: test
> password: coucou password: coucou
> port: port:
> comment: comment:
```