TALER-CYCLOS(1)

NAME
taler-cyclos - implementation of Cyclos Taler adapter

SYNOPSIS

taler-cyclos [-h | --help] [--version] COMMAND [ARGS...]

Subcommands: dbinit, setup, serve, worker, taler-deployment, config

DESCRIPTION

taler-cyclos is a Taler adapter for the Cyclos API.

Its options are as follows:

-h | --help
    Print short help on options.

--version
    Print version information.

    The interaction model is as follows:

•   Configure the database with commands dbinit.

•   Check API access with commands setup.

•   After a successful setup, the subcommands worker can be run to both send payments and sync the bank account history.

•   Start the HTTP server with command serve. Let this run in a shell, writing logs to stderr.

    The following sections describe each command in detail.

  dbinit

This command defines the database schema for taler-cyclos. It is mandatory to run this command before invoking the setup or serve commands.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-r | --reset
    Reset database (DANGEROUS: All existing data is lost)

-h | --help
    Print short help on options.

  setup

This command establishes a working API connection. It verifies that the current configuration is valid and that the bank account has sufficient rights to function as an exchange.

It is mandatory to run this command before invoking the worker command.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-r | --reset
    Reset connection info and overwrite keys file

-h | --help
    Print short help on options.

  worker

This subcommand initiate transaction throught the Cyclos API and sync the bank account history.

If ACCOUNT_TYPE is exchange, incoming payments with an invalid Taler subject are bounced.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

--transient
    Execute once and return.

-h | --help
    Print short help on options.

  serve

This command starts the HTTP server.

Its options are as follows:

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

--check
    Check whether an API is in use (if it's useful to start the HTTP server). Exit with 0 if at least one API is enabled, otherwise 1.

-h | --help
    Print short help on options.

  taler-deployment

Helpers to integrate taler-cyclos with taler-exchange.

-h | --help
    Print short help on options.

    Subcommands: exchange-payto, wire-gateway-credentials

  taler-deployment exchange-payto

Output the exchange payto.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-h | --help
    Print short help on options

  taler-deployment wire-gateway-credentials

Output the wire gateway credentials configuration.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-h | --help
    Print short help on options

  config

This command inspect or change the configuration.

-h | --help
    Print short help on options.

    Subcommands: get, dump, pathsub

  config get

This command lookup config value.

It takes two arguments, the section name and the option name

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-f | --filename
    Interpret value as path with dollar-expansion.

-h | --help
    Print short help on options.

  config dump

This command dump the configuration.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-h | --help
    Print short help on options.

  config pathsub

This command substitute variables in a path.

It takes one argument, a path expression.

-c | --config config_file
    Specifies the configuration file.

-L | --log LOGLEVEL
    Configure logging to use LOGLEVEL.

-h | --help
    Print short help on options.

SEE ALSO

taler-cyclos.conf(5)

BUGS

Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.

AUTHOR
GNU Taler contributors

COPYRIGHT
2014-2025 Taler Systems SA (GPLv3+ or GFDL 1.3+)