Command index
Every JSON-capable command, with what it touches. “Identity” means the local mcli.db
must already exist; only identity init creates it.
| CLI path | command | Kind | Network | Identity | Local write | --yes | Statuses |
|---|---|---|---|---|---|---|---|
schema | schema | offline | none | no | no | no | ok, error |
identity init | identity.init | local write | none | creates it | mcli.db | no | ok, error |
identity show | identity.show | local read | none | yes (read) | no | no | ok, error |
order mine | order.mine | local read | none | yes (read) | no | no | ok, error |
order list | order.list | public read | reads relays | no | no | no | ok, error |
order info | order.info | request | 1 signed request | yes (read) | no | no | ok, error |
message list | message.list | private read | reads relays | yes (read) | no | no | ok, error |
order sync | order.sync | private read + local write | reads relays | yes | order rows | no | ok, error, uncertain |
order new | order.new | write | 1 signed request | yes | index + row | yes | ok, error, uncertain |
order take-sell | order.take-sell | write | 1 signed request | yes | index + row | yes | ok, error, uncertain |
order take-buy | order.take-buy | write | 1 signed request | yes | index + row | yes | ok, error, uncertain |
order add-invoice | order.add-invoice | write | 1 signed request | yes | status | yes | ok, error, uncertain |
bond add-invoice | bond.add-invoice | write | 1 signed request | yes | none | yes | ok, error, uncertain |
order fiat-sent | order.fiat-sent | write | 1 signed request | yes | status (+ index) | yes | ok, error, uncertain |
order release | order.release | write | 1 signed request | yes | status (+ index) | yes | ok, error, uncertain |
order cancel | order.cancel | write | 1 signed request | yes | status | yes | ok, error, uncertain |
dispute open | dispute.open | write | 1 signed request | yes | status | yes | ok, error, uncertain |
order rate | order.rate | write | 1 signed request | yes | none | yes | ok, error, uncertain |
All of them need MOSTRO_PUBKEY and RELAYS except schema, identity init,
identity show and order mine, which only use the local data directory (MCLI_DIR,
else ~/.mcli) or nothing at all.
Which key signs what
| Command | Signed with |
|---|---|
order info | Identity key (index 0) |
order new, order take-* | A new trade key at the next trade index (reserved locally first) |
order add-invoice, bond add-invoice, order fiat-sent, order release, order cancel, dispute open, order rate | The trade key stored with the order’s local row (hence order_unknown when the row is missing) |
Command page layout
Each page has the same sections: a summary table, Invocation, Input, Behavior,
Success data, Outcomes, Errors, Warnings, Examples and Next.
The input and output schemas quoted are in schemas/<command>.input.json and
schemas/<command>.output.json.
Input schemas
The discovery document gives an input_schema per command, generated from the argument
parser: one property per long option (fiat-amount, yes…). Values are typed as
strings because they are command-line tokens, except the flag yes, a boolean, and the
repeatable order info --order, an array of strings. A wrapper can use it to build forms or
LLM tool definitions, then turn the object into argv: {"order": "…", "yes": true} →
--order … --yes; an array gives the option once per value.