summaryrefslogtreecommitdiff
path: root/README
blob: 77ddc82ebd31ca222d88f8fc475e8bda845f0b48 (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
-*- mode: org -*-

Shroud is a simple password manager with a command line interface.
The password database is stored as a Scheme s-expression and encrypted
with a [[gnupg.org][GnuPG]] key.

* Usage

  #+BEGIN_SRC sh
    # Add a new secret
    shroud hide --id=bank-account --username=foobar --password=hackme

    # Replace an existing secret
    shroud hide --replace --id=bank-account --username=foobar --password=hackmepls

    # Show a saved secret
    shroud show bank-account

    # Show just the password
    shroud show --password bank-account

    # Delete a secret
    shroud remove bank-account
  #+END_SRC

* Dependencies

  - GNU Guile >= 2.0.11
  - GnuPG >= 1.4

* Installation

  Shroud uses the familiar GNU build system.

  #+BEGIN_SRC sh
    ./bootstrap && ./configure && make && make install
  #+END_SRC