anastasis

Credential backup and recovery protocol and service
Log | Files | Refs | Submodules | README | LICENSE

anastasis-reducer.1.rst (2704B)


      1 anastasis-reducer(1)
      2 ####################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **anastasis-reducer** - CLI for Anastasis
     10 
     11 Synopsis
     12 ========
     13 
     14 **anastasis-reducer**
     15 [**-A**_*ID*_|_**--application=**\ \ *ID*]
     16 [**-a**_*JSON*_|_**--arguments=\ \ *JSON*]
     17 [**-b**_|_**--backup]
     18 [**-c** *FILENAME* | **––config=**\ ‌\ *FILENAME*]
     19 [**-h** | **––help**]
     20 [**-L** *LOGLEVEL* | **––loglevel=**\ ‌\ *LOGLEVEL*]
     21 [**-l** *FILENAME* | **––logfile=**\ ‌\ *FILENAME*]
     22 [**-r**_|_**--restore]
     23 [**-v** | **––version**] COMMAND
     24 
     25 
     26 Description
     27 ===========
     28 
     29 **anastasis-reducer** is a command-line tool to run Anastasis
     30 key recover and backup operations using a reducer-style interface.
     31 The reducer will read the current state from standard input and
     32 write the resulting state to standard output.  A COMMAND must
     33 be given on the command line.  The arguments (if any) are to
     34 be given in JSON format to the **-a** option.  A list of
     35 commands can be found in the :doc:`../reducer`
     36 chapter.
     37 
     38 **-a** *JSON* \| **––arguments=**\ \ *JSON*
     39    Provide JSON inputs for the given command.
     40 
     41 **-A** *ID* \| **--application=**\ \ *ID*
     42    Set the application ID to *ID*. Default is empty, which means the application-id must be explicitly provided
     43    as part of the JSON inputs or it will be omitted.
     44    The **-A** option overrides any application ID that
     45    may be given in the **-a** arguments. Application IDs
     46    are used to store different types of secrets from different applications
     47    while using the same user attributes. Basically the application ID
     48    is included in the user attributes. Applications that
     49    tightly integrate Anastasis should set the application ID to their
     50    respective unique name, for example the GNU Taler wallet may use
     51    ``gnu-taler-wallet`` for the application ID.
     52    Forgetting the application ID makes the secrets irrecoverable.
     53 
     54 **-b** \| **--backup**
     55    Begin fresh reducer operation for a back up operation.
     56 
     57 **-c** *FILENAME* \| **––config=**\ ‌\ *FILENAME*
     58    Use the configuration from *FILENAME*.
     59 
     60 **-h** \| **––help**
     61    Print short help on options.
     62 
     63 **-L** *LOGLEVEL* \| **––loglevel=**\ ‌\ *LOGLEVEL*
     64    Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
     65    ``WARNING``, ``ERROR``.
     66 
     67 **-l** *FILENAME* \| **––logfile=**\ ‌\ *FILENAME*
     68    Send logging output to *FILENAME*.
     69 
     70 **-r** \| **--restore**
     71    Begin fresh reducer operation for a restore operation.
     72 
     73 **-v** \| **––version**
     74    Print version information.
     75 
     76 See Also
     77 ========
     78 
     79 anastasis-gtk(1), anastasis-httpd(1), anastasis.conf(5).
     80 
     81 Bugs
     82 ====
     83 
     84 Report bugs by using https://bugs.anastasis.lu/ or by sending electronic
     85 mail to <contact@anastasis.lu>.