1SECRET-TOOL(1)                   User Commands                  SECRET-TOOL(1)
2
3
4

NAME

6       secret-tool - Store and retrieve passwords
7

SYNOPSIS

9       secret-tool store --label='Label' {attribute} {value} ...
10
11       secret-tool lookup {attribute} {value} ...
12
13       secret-tool clear {attribute} {value} ...
14
15       secret-tool search [--all]{attribute} {value} ...
16

DESCRIPTION

18       secret-tool is a command line tool that can be used to store and
19       retrieve passwords.
20
21       Each password is stored in an item. Items are uniquely identified by a
22       set of attribute keys and values. When storing a password you must
23       specify unique pairs of attributes names and values, and when looking
24       up a password you provide the same attribute name and value pairs.
25

STORE

27       To store a password run secret-tool with the store argument. You must
28       also specify a label for the password with the --label argument. This
29       label will be displayed in the password manager.
30
31       Make sure to pass a unique set of attributes names and values when
32       storing a password. If the attributes match an already existing item,
33       it will be updated instead of creating a new item.
34
35       If invoked from a terminal or tty, then the password to store will be
36       prompted for and only one line will be accepted.
37
38       A password to store can also be piped in via stdin. The password will
39       be the contents of stdin until EOF. If you provide a newline via stdin
40       it will be stored as part of the password.
41

LOOKUP

43       To lookup a password run secret-tool with the lookup argument. Specify
44       the same same attribute names and value pairs that you passed when
45       storing the password.
46
47       If multiple items match the attribute provided, then the first password
48       that is already unlocked will be returned. If necessary an item will be
49       unlocked.
50
51       When printing the password to a terminal or tty, an extra newline will
52       be added after the password.
53

CLEAR

55       To remove a password run secret-tool with the clear argument. Specify
56       the same attribute name and value pairs that you passed when storing
57       the password.
58
59       All unlocked items that match the attributes will be removed.
60

62       This command searches for and prints details on matching items in
63       secret service. Specify the same attribute and value pairs that you
64       passed in when storing the password. You can use the following options:
65
66       --all
67           Return all matching results, rather than just the one of the
68           matches. Without this option, the first unlocked match returned
69           from the service will be printed.
70
71       --unlock
72           Unlock items that are locked and then print out their details.
73           Without this option, locked items are skipped.
74

EXIT STATUS

76       On success 0 is returned, a non-zero failure code otherwise.
77

EXAMPLES

79       Example 1. Storing, retrieving, and clearing a password
80
81           $ secret-tool store --label='My password' key1 value1 key2 value2
82           Password: My password
83
84           $ secret-tool lookup key1 value1 key2 value2
85           My password
86
87           $ secret-tool clear key1 value1 key2 value2
88
89
90
91
92XDG                                                             SECRET-TOOL(1)
Impressum