The following list shows all the CLI subcommands
acting as the Circuit API's client side.  Each section
name is one subcommand available in this pattern:
``libeufin-cli sandbox demobank $subcommand``.

Finally, each section name links to the related API
documentation of the endpoint being addressed.

:ref:`circuit-account-info <circuit-account-info>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Retrieve Circuit information about one account.  Useful to get cash-out
  address and contact details.

Options:
  --username TEXT  Username of the account to retrieve.  It defaults to
                   LIBEUFIN_SANDBOX_USERNAME and doesn't accept 'admin'.
  --help           Show this message and exit.

:ref:`circuit-accounts <circuit-account-list>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Gets the list of all the accounts managed by the Circuit.  Only 'admin'
  allowed

Options:
  --help  Show this message and exit.

:ref:`circuit-cashout <circuit-cashout>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Create a cash-out operation.  If successful, the user gets a TAN.

Options:
  --subject TEXT        Payment subject to associate to the outgoing and
                        incoming payments that are associated with this cash-
                        out operation.
  --amount-debit TEXT   Amount that will debited to the local currency
                        account, in the <currency>:X.Y format.  [required]
  --amount-credit TEXT  Amount that will credited to the fiat currency
                        account, in the <currency>:X.Y format.  [required]
  --tan-channel TEXT    Indicates how to send the TAN to the user: 'sms',
                        'email' and 'file' are valid values.  If missing, the
                        bank defaults to SMS.  'file' makes the server write
                        the TAN to /tmp/libeufin-cashout-tan.txt, normally
                        used for testing.
  --help                Show this message and exit.


:ref:`circuit-cashout-abort <circuit-cashout-abort>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Abort a cash-out operation.  Admin and author are allowed to request.

Options:
  --uuid TEXT  UUID of the cash-out operation to abort.  [required]
  --help       Show this message and exit.


:ref:`circuit-cashout-confirm <circuit-cashout-confirm>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Confirm a cash-out operation.  Only the author is allowed (no admin).

Options:
  --tan TEXT   TAN that authorizes the cash-out operaion.  [required]
  --uuid TEXT  UUID of the cash-out operation to confirm.  [required]
  --help       Show this message and exit.


:ref:`circuit-cashout-details <circuit-cashout-details>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Retrieve status information about one cash-out operation.  Admin and author
  are allowed to request.

Options:
  --uuid TEXT  UUID of the cash-out operation to retrieve.  [required]
  --help       Show this message and exit.


:ref:`circuit-cashouts <circuit-cashouts>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Gets the list of all the pending and confirmed cash-out operations.

Options:
  --help  Show this message and exit.


:ref:`circuit-delete-account <circuit-delete-account>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Delete one account.  Only available to the administrator and for accounts
  with zero balance.

Options:
  --username TEXT  account to delete  [required]
  --help           Show this message and exit.


:ref:`circuit-password-reconfig <circuit-password-reconfig>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Ask interactively to change the password. It needs administrator or owner
  credentials

Options:
  --username TEXT  Username whose password will change.  Defaults to
                   LIBEUFIN_SANDBOX_USERNAME and doesn't accept 'admin' as a
                   value.
  --help           Show this message and exit.


:ref:`circuit-reconfig <circuit-reconfig>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Reconfigure an account with cash-out capabilities.  It needs administrator
  or owner credentials

Options:
  --phone TEXT            Phone number for the SMS TAN
  --email TEXT            E-mail address for receiving the TAN
  --cashout-address TEXT  Payto address where to send fiat payments on cash-
                          outs  [required]
  --username TEXT         Username associated with the account to reconfigure.
                          It defaults to LIBEUFIN_SANDBOX_USERNAME and doesn't
                          accept 'admin'.
  --help                  Show this message and exit.


:ref:`circuit-register <circuit-register>`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

  Register a new account with cash-out capabilities.  It needs administrator
  credentials, and the new account password exported in
  LIBEUFIN_NEW_CIRCUIT_ACCOUNT_PASSWORD.

Options:
  --username TEXT         new account username  [required]
  --cashout-address TEXT  Payto address where to send fiat payments on cash-
                          outs  [required]
  --name TEXT             Legal name associated to the account.  [required]
  --phone TEXT            SMS where to send the cash-out TAN.
  --email TEXT            E-mail address where to send the cash-out TAN.
  --internal-iban TEXT    Which IBAN to associate to this account.  The IBAN
                          participates only in the local currency circuit.  If
                          missing, the bank generates one.
  --help                  Show this message and exit.