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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
libeufin-cli(1)
###############
.. only:: html
Name
====
**libeufin-cli** - Interact with LibEuFin Sandbox and Nexus
Synopsis
========
**libeufin-cli**
[**-h** | **--help**]
[**--version**]
COMMAND [ARGS...]
Commands: accounts, connections, facades, permissions, sandbox, users
Description
===========
**libeufin-cli** is the user interface program to interact
with **libeufin-sandbox** and **libeufin-nexus** when they are
operating as HTTP servers, listening on localhost ports.
Normally, you invoke them with their respective ``serve`` commands,
and in a separate shell, use **libeufin-cli** to send requests
and receive responses from them.
The interaction model is as follows:
- (Optionally) Start the sandbox.
- Start the nexus.
- Use **libeufin-cli** to interact with them.
You can manage users and permissions, bank accounts, "facades",
transactions, and connections between the various systems.
For **libeufin-cli** to be able to communicate with **libeufin-sandbox**,
the following environment variables need to be set:
``LIBEUFIN_SANDBOX_USERNAME``
This should normally be ``admin``.
``LIBEUFIN_SANDBOX_PASSWORD``
This is the same password chosen when the sandbox was started.
``LIBEUFIN_SANDBOX_URL``
This is ``http://localhost:PORT/``, where ``PORT`` is the
same port chosen when the sandbox was started.
This URL can also be specified with the ``--sandbox-url URL``
option to the ``sandbox`` command (see below).
For **libeufin-cli** to be able to communicate with **libeufin-nexus**,
the following environment variables need to be set:
``LIBEUFIN_NEXUS_USERNAME``
This is the same username chosen by the nexus ``superuser`` command.
``LIBEUFIN_NEXUS_PASSWORD``
This is the same username chosen by the nexus ``superuser`` command.
``LIBEUFIN_NEXUS_URL``
This is ``http://localhost:PORT/``, where ``PORT`` is the
same port chosen when the nexus was started.
Of the six commands, the ``sandbox`` command talks to the sandbox,
while the other five commands talk to the nexus.
The following sections describe each command and their subcommands in detail.
sandbox
-------
WRITEME
users
-----
WRITEME
permissions
-----------
WRITEME
accounts
--------
WRITEME
connections
-----------
WRITEME
facades
-------
WRITEME
See Also
========
.. TODO: libeufin-sandbox(1), libeufin-cli(1).
Bugs
====
Report bugs by using https://bugs.taler.net or by sending electronic
mail to <taler@gnu.org>.
|
