krz/rust-pass

clone: git clone https://gitbay.org/krz/rust-pass.git

main: README.nfo · raw

 1┌──────────────────────────────────────────────────────────────┐
 2│  R P A S S                                 [ KRZ ]   krz.sh  │
 3└──────────────────────────────────────────────────────────────┘
 4
 5WHAT
 6  command-line password manager in rust + sqlite. manages accounts
 7  and generates random ascii passwords or xkcd-style passphrases.
 8
 9  data is encrypted before it's written to the sqlite database using
10  the fernet crate. the key is a random vault.key stored in plaintext,
11  so anyone who can read the key can decrypt the database.
12  password-protecting the key file is not done yet.
13
14  not production-ready. see TODO.
15
16USE
17      rpass ARGUMENT [VALUES]
18
19  arguments:
20  -h  --help                       print the welcome message
21  -n  --new                        create an account
22  -l  --list                       list saved accounts
23  -e  --edit [UUID] [FIELD_NAME]   edit an account
24  -d  --delete [UUID]              delete an account
25  -p  --purge                      purge all accounts, delete the vault
26
27TODO
28  - edit, delete, and purge accounts
29  - password to protect the key file
30  - test suite
31  - publish to crates.io
32  - clean up dead code and unused imports
33
34DEVELOP
35      git clone REPO_URL
36      cd REPO
37
38  local test:
39
40      cargo build --release
41      ./target/release/REPO --help
42
43  publish to crates.io:
44
45      cargo build --release
46      cargo login [API_TOKEN]
47      cargo publish --dry-run
48      cargo publish
49
50CONTRIBUTING
51  fork, add features, open a pull request.
52
53┌──────────────────────────────────────────────────────────────┐
54│  krz.sh                                                      │
55└──────────────────────────────────────────────────────────────┘