44
55Very simple command line interface that show all new replaceable events from [ Mostro] ( https://github.com/MostroP2P/mostro )
66
7- ## Requirements:
7+ ## Requirements
88
990 . You need Rust version 1.64 or higher to compile.
10101 . You will need a lightning network node
1111
12- ## Install dependencies:
12+ ## Install dependencies
1313
1414To compile on Ubuntu/Pop!\_ OS, please install [ cargo] ( https://www.rust-lang.org/tools/install ) , then run the following commands:
1515
16- ```
17- $ sudo apt update
18- $ sudo apt install -y cmake build-essential pkg-config
16+ ``` bash
17+ sudo apt update
18+ sudo apt install -y cmake build-essential pkg-config
1919```
2020
2121## Install
2222
2323To install you need to fill the env vars (` .env ` ) on the with your own private key and add a Mostro pubkey.
2424
25- ```
26- $ git clone https://github.com/MostroP2P/mostro-cli.git
27- $ cd mostro-cli
28- $ cp .env-sample .env
29- $ cargo run
25+ ``` bash
26+ git clone https://github.com/MostroP2P/mostro-cli.git
27+ cd mostro-cli
28+ cp .env-sample .env
29+ cargo run
3030```
3131
32- # Usage
32+ ## Usage
3333
34- ```
34+ ``` bash
3535Commands:
36- listorders Requests open orders from Mostro pubkey
37- neworder Create a new buy/sell order on Mostro
38- takesell Take a sell order from a Mostro pubkey
39- takebuy Take a buy order from a Mostro pubkey
40- addinvoice Buyer add a new invoice to receive the payment
41- getdm Get the latest direct messages from Mostro
42- fiatsent Send fiat sent message to confirm payment to other user
43- release Settle the hold invoice and pay to buyer
44- cancel Cancel a pending order
45- rate Rate counterpart after a successful trade
46- dispute Start a dispute
47- admcancel Cancel an order (only admin)
48- admsettle Settle a seller's hold invoice (only admin)
49- admlistdisputes Requests open disputes from Mostro pubkey
50- admaddsolver Add a new dispute's solver (only admin)
51- admtakedispute Admin or solver take a Pending dispute (only admin)
52- help Print this message or the help of the given subcommand(s)
36+ listorders Requests open orders from Mostro pubkey
37+ neworder Create a new buy/sell order on Mostro
38+ takesell Take a sell order from a Mostro pubkey
39+ takebuy Take a buy order from a Mostro pubkey
40+ addinvoice Buyer add a new invoice to receive the payment
41+ getdm Get the latest direct messages
42+ getadmindm Get the latest direct messages for admin
43+ senddm Send direct message to a user
44+ fiatsent Send fiat sent message to confirm payment to other user
45+ release Settle the hold invoice and pay to buyer
46+ cancel Cancel a pending order
47+ rate Rate counterpart after a successful trade
48+ restore Restore session to recover all pending orders and disputes
49+ dispute Start a dispute
50+ admcancel Cancel an order (only admin)
51+ admsettle Settle a seller' s hold invoice (only admin)
52+ admlistdisputes Requests open disputes from Mostro pubkey
53+ admaddsolver Add a new dispute' s solver (only admin)
54+ admtakedispute Admin or solver take a Pending dispute (only admin)
55+ admsenddm Send gift wrapped direct message to a user (only admin)
56+ conversationkey Get the conversation key for direct messaging with a user
57+ getlasttradeindex Get last trade index of user
58+ help Print this message or the help of the given subcommand(s)
5359
5460Options:
5561 -v, --verbose
@@ -60,9 +66,9 @@ Options:
6066 -V, --version Print version
6167```
6268
63- # Examples
69+ ## Examples
6470
65- ```
71+ ``` bash
6672$ mostro-cli -m npub1ykvsmrmw2hk7jgxgy64zr8tfkx4nnjhq9eyfxdlg3caha3ph0skq6jr3z0 -r ' wss://nos.lol,wss://relay.damus.io,wss://nostr-pub.wellorder.net,wss://nostr.mutinywallet.com,wss://relay.nostr.band,wss://nostr.cizmar.net,wss://140.f7z.io,wss://nostrrelay.com,wss://relay.nostrr.de' listorders
6773
6874# You can set the env vars to avoid the -m, -n and -r flags
0 commit comments