summaryrefslogtreecommitdiff
path: root/README
blob: 79a167b0086768c11d75490ef1c64363a5fc4b85 (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
38
39
40
41
42
43
44
45
46
-*- mode: org -*-

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

Each secret is indentified by a unique name and may contain an
arbitrary set of key/value data pairs.

* Usage

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

    # Edit an existing secret:
    shroud hide --edit bank-account password=hackmepls

    # List all secrets:
    shroud list

    # Show all key/value pairs for a saved secret:
    shroud show bank-account

    # Show a single value in a secret:
    shroud show bank-account password

    # Copy a password directly to X clipboard:
    shroud show -c bank-account password

    # 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