A command line client for ripple trading. Now ripple-commander is using Ripple REST API.
If you appreciate the work, welcome donate some xrp to
Install nodejs (>=4.0.0).
Checkout the source code.
git clone https://github.com/kuyur/ripple-commander.git
Download necessary node modules.
cd ripple-commander npm install
Before running the commander, you should copy
config.json.sampleand rename the new file to
config.json. Use a text editor to open
config.json, edit the
serverfield to your private or trusted one. If you trust Ripple Labs 100%, you still can use the default configuration(
https://api.ripple.com/v1) until it is shutdown.
Run commander. Account (ripple address) and secret will be required and saved to
wallet.txtfor the first time.
Type help to see available commands. Press Ctrl+C to exit.
Generate a new ripple account(address and secret pair), notice that the secret and address are generated by REST server.
Get balance of current account
Get trustlines of current account
Grant or remove a trustline, set limit to 0 for removing.
grant-trustline <issuer> <currency> <limit> [ --allow-rippling ]
Send money, for example,
send rscxz5PqRrmUaMigyb1mP32To1rQDygxAq 20+XRP.
send <destination> <amount+currency+issuer> [ --source-tag=<source_tag> ] [ --destination-tag=<destination_tag> ] [ --invoice-id=<invoice_id> ]
Send money to bridge, for example
send-to-bridge firstname.lastname@example.org 100, you will be asked for detail later.
send-to-bridge <destination> <amount>
Get payment detail
Get detail of recent payments
Place an order, type can be
place-order <type> <amount1+currency1+issuer1> <amount2+currency2+issuer2>
Cancel an order
Get orderbook of currency pair, notice that orders generated by auto-bridge are not contained in the list.
get-orderbook <currency1+issuer1> <currency2+issuer2> [ --limit=<limit> ]
Get transaction status
Show list of trusted issuers, Data is from https://ripple.com/knowledge_center/gateway-information/. You can add custom gateways by editing
show-issuers [ --keyword=<issuer_name> ]
Show all accounts in wallet, the top one is the account currently in use.
show-accounts [ --show-secret ]
Add an account into wallet
add-account [ <address> ]
Change the activated account (account currently in use)
change-account [ <address> ]
Remove an account from wallet
remove-account [ <address> ]
Encrypt wallet, Use AES to protect the wallet file. Afte encryption, wallet.txt will be removed and wallet.dat will be generated.
- Trading. (grant trustline, send money, place order, cancel order, etc.)
- Federation protocol supported. You can withdraw money by sending IOU to automatic bridge.
- Wallet protection.
- Account management.
- Command auto-complete.
- Generate new ripple account offline.
- Offline signature and discard REST api.
The MIT License.