LIBEUFIN-BANK(1)

📦 version 1.3.0, in nixos 26.05, nixpkgs unstable

💖 LIBEUFIN-BANK 💖

okay so bestie, welcome to the libeufin-bank(1) page — this is the GNU Taler manual, and today we're learning about libeufin-bank, which is literally an implementation of a regional currency bank. yes. a whole bank. in a program. slay. 🏦✨

🌸 NAME 🌸

libeufin-bank — implementation of a regional currency bank 🫶

✨ SYNOPSIS ✨

libeufin-bank [-h | --help] [--version] COMMAND [ARGS...]

Subcommands: dbinit, passwd, create-token, serve, create-account,
edit-account, gc, bench-pwh, config

like, yes, that's the whole shape of it — one binary, a bunch of commands. iykyk 💅

🦋 DESCRIPTION 🦋

libeufin-bank is a program that implements a simple core banking system with account and REST APIs — including REST APIs for a Web interface and REST APIs to interact with GNU Taler components. so it's not just a bank, it's a bank with a whole social life. main character energy fr fr 👑

Its options are as follows:

  • -h | --help — Print short help on options.
  • –version — Print version information.
yes bestie, that dash in –version is an en dash in the original page. we do not fix it. we respect the lore. 💀

The interaction model is as follows — think of it as the get-ready-with-me routine:

  • Configure the database with commands dbinit.
  • Set admin account password with commands passwd.
  • 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. buckle up 🎀

🗄️ dbinit

This command defines the database schema for LibEuFin Bank. It is mandatory to run this command before invoking the passwd or serve commands. like, do not skip this step. do not pass go. do not collect $200. 🙈

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.
⚠️ real talk: --reset is DANGEROUS and all existing data is lost. no cap. don't come crying to me. 😭

🔑 passwd

This command change any account password.

It takes two arguments, the account username and the account new password.

Its options are as follows:

  • -c | --config config_file — Specifies the configuration file.
  • -L | --log LOGLEVEL — Configure logging to use LOGLEVEL.
  • -h | --help — Print short help on options.

🎟️ create-token

Create authentication token for a userword. (yes, "userword". that's what it says. iconic typo behavior, we keep it 💅)

Its options are as follows:

  • -c | --config config_file — Specifies the configuration file.
  • -L | --log LOGLEVEL — Configure logging to use LOGLEVEL.
  • -u | --user | --username USERNAME — Account username.
  • -s | --scope SCOPE — Scope for the token.
  • -d | --duration forever|MICROS — Custom token validity duration.
  • --description DESCRIPTION — Optional token description.
  • --refreshable — Make the token refreshable into a new token.
  • --current-token TOKEN — Current token to reuse if still valid.
  • -h | --help — Print short help on options.

🖥️ serve

This command starts the HTTP server. let it run in a shell, writing logs to stderr — that's the vibe, don't fight it 🌈

Its options are as follows:

  • -c | --config config_file — Specifies the configuration file.
  • -L | --log LOGLEVEL — Configure logging to use LOGLEVEL.
  • -h | --help — Print short help on options.

👤 create-account

This command create a bank account and prints its payto://-URI to STDOUT. new account, who dis 🎀

Its options are as follows:

  • -c | --config config_file — Specifies the configuration file.
  • -L | --log LOGLEVEL — Configure logging to use LOGLEVEL.
  • -u | --user | --username USERNAME — Account unique username.
  • -p | --password PASSWORD — Account password used for authentication.
  • --name NAME — Legal name of the account owner.
  • --public — Make this account visible to anyone.
  • --exchange — Make this account a taler exchange.
  • --email EMAIL — E-Mail address used for TAN transmission.
  • --phone PHONE_NUMBER — Phone number used for TAN transmission.
  • --cashout_payto_uri PAYTO_URI — Payto URI of a fiant account who receive cashout amount.
  • --payto_uri PAYTO_URI — Payto URI of this account.
  • --debit_threshold AMOUNT — Max debit allowed for this account.
  • --tan_channel TAN_CHANNEL — Enables 2FA and set the TAN channel used for challenges.
  • -h | --help — Print short help on options.

✏️ edit-account

This command edit an existing account.

It takes one argument, the account username.

Its options are as follows:

  • -c | --config config_file — Specifies the configuration file.
  • -L | --log LOGLEVEL — Configure logging to use LOGLEVEL.
  • --name NAME — Legal name of the account owner.
  • --public true|false — Make this account visible to anyone.
  • --email EMAIL — E-Mail address used for TAN transmission.
  • --phone PHONE_NUMBER — Phone number used for TAN transmission.
  • --cashout_payto_uri PAYTO_URI — Payto URI of this account.
  • --debit_threshold AMOUNT — Max debit allowed for this account.
  • --tan_channel TAN_CHANNEL — Enables 2FA and set the TAN channel used for challenges.
  • -h | --help — Print short help on options.
🫶 little heads-up bestie: on create-account that --cashout_payto_uri says "Payto URI of a fiant account who receive cashout amount", and here on edit-account it just says "Payto URI of this account". two different sentences, both canon, both staying. 🧚

🧹 gc

This command performs garbage collection: abort expired operations and clean expired data. literally taking out the trash, but for a bank 🍓

Its options are as follows:

  • -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. everything. on main. 💀

  • -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 👀

libeufin-bank.conf(5)

💀 BUGS 💀

Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>. please do, the contributors genuinely want to know 🫶

🌟 AUTHOR 🌟

GNU Taler contributors

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

and that's the page bestie!! 💖✨ version 1.0, dated Dec 22, 2025 — LIBEUFIN-BANK(1), and it's giving documentation that ate. go configure your database before you touch passwd or serve, and remember: --reset will delete everything and not feel bad about it. mwah 🎀💅🦋

📦 where this page comes from