Skip to content

Commit

Permalink
Sync readme with current help text
Browse files Browse the repository at this point in the history
  • Loading branch information
creshal committed Apr 8, 2016
1 parent 4075edd commit e47326a
Showing 1 changed file with 33 additions and 22 deletions.
55 changes: 33 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,45 @@ See below for usage information and `HACKING.md` for architectural information.

scrypt based password manager.

Actions:
new Prompts for title/description and generates a new password
with supplied entropy (default: 64 bit)
add Prompts for title, description and password
edit Edits an entry matching the query string
del Deletes the entry with the supplied ID
get Searches the DB for the supplied query string
Shows the whole database if no query is supplied, this can
take a while.
copy Same as 'get', uses `copy_command` on (selectable) query result.
Default: Calls xsel to copy the result to primary selection.
pwgen Generate a random password with supplied entropy and print it
(default: 64 bit)
import Imports passwords from a CSV file.
Column order is title, description, password
The format is the default Excel/Calc format (comma separation,
quoting optional).
migrate Re-syncs the database, migrating it to new database formats
and doing other maintenance if necessary.
This is also done automatically on all writing operations
(i.e., add/del/edit/new/import).
Actions:
new Prompts for title/description and generates a new password
with supplied entropy (default: 64 bit)

add Prompts for title, description and password

edit Edits an entry matching the query string

del Deletes the entry with the supplied ID

get Searches the DB for the supplied query string
Shows the whole database if no query is supplied, this can
take a while.

list Same as get, but does not show passwords, only metadata.

copy Same as 'get', uses `copy_command` on (selectable) query result.
Default: Calls xsel to copy the result to primary selection.

pwgen Generate a random password with supplied entropy and print it
(default: 64 bit)

import Imports passwords from a CSV file.
Column order is title, description, password
The format is the default Excel/Calc format (comma separation,
quoting optional).

migrate Re-syncs the database, migrating it to new database formats
and doing other maintenance if necessary.
This is also done automatically on all writing operations
(i.e., add/del/edit/new/import).


Password generator options:
x, xkcd Random word generator as per XKCD 936
a, alnum Random letters/numbers
p, print Random characters (letters, digits, punctuation)

positional arguments:
Positional arguments:
{migrate,new,add,edit,del,get,copy,pwgen,import}
query Search string

Expand Down

0 comments on commit e47326a

Please sign in to comment.