summaryrefslogtreecommitdiff
path: root/doc/sphinx/manpages/anastasis-reducer.1.rst
blob: 9884b185e182fca48950fb207b797e8f62835e97 (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
anastasis-reducer(1)
####################

.. only:: html

   Name
   ====

   **anastasis-reducer** - CLI for Anastasis

Synopsis
========

**anastasis-reducer**
[**-A**_*ID*_|_**--application=**\ \ *ID*]
[**-a**_*JSON*_|_**--arguments=\ \ *JSON*]
[**-b**_|_**--backup]
[**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*]
[**-h** | **––help**]
[**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
[**-l** *FILENAME* | **––logfile=**\ ‌\ *FILENAME*]
[**-r**_|_**--restore]
[**-v** | **––version**] COMMAND


Description
===========

**anastasis-reducer** is a command-line tool to run Anastasis
key recover and backup operations using a reducer-style interface.
The reducer will read the current state from standard input and
write the resulting state to standard output.  A COMMAND must
be given on the command line.  The arguments (if any) are to
be given in JSON format to the **-a** option.  A list of
commands can be found in the :doc:`../reducer`
chapter.

**-a** *JSON* \| **––arguments=**\ \ *JSON*
   Provide JSON inputs for the given command.

**-A** *ID* \| **--application=**\ \ *ID*
   Set the application ID to *ID*. Default is empty, which means the application-id must be explicitly provided
   as part of the JSON inputs or it will be omitted.
   The **-A** option overrides any application ID that
   may be given in the **-a** arguments. Application IDs
   are used to store different types of secrets from different applications
   while using the same user attributes. Basically the application ID
   is included in the user attributes. Applications that
   tightly integrate Anastasis should set the application ID to their
   respective unique name, for example the GNU Taler wallet may use
   ``gnu-taler-wallet`` for the application ID.
   Forgetting the application ID makes the secrets irrecoverable.

**-b** \| **--backup**
   Begin fresh reducer operation for a back up operation.

**-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
   Use the configuration from *FILENAME*.

**-h** \| **––help**
   Print short help on options.

**-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL*
   Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
   ``WARNING``, ``ERROR``.

**-l** *FILENAME* \| **––logfile=**\ ‌\ *FILENAME*
   Send logging output to *FILENAME*.

**-r** \| **--restore**
   Begin fresh reducer operation for a restore operation.

**-v** \| **––version**
   Print version information.

See Also
========

anastasis-gtk(1), anastasis-httpd(1), anastasis.conf(5).

Bugs
====

Report bugs by using https://bugs.anastasis.lu/ or by sending electronic
mail to <contact@anastasis.lu>.