High Level User Guide
The LedgerSwarm Command Line
The command line tool allows you to interact with your LedgerSwarm participant to propose and approve transactions, set up accounts, maintain settlement routes and to examine ledger balances.
Usage: ledgerswarm [options] [command]
Each command has options which are the parameters required to execute that command - such as the account from which a transfer will take place. Options can be entered on the command line or, if not entered on the command line, will be prompted for by the command line tool.
Options
| Option | Description |
|---|---|
| -V, --version | Show the version |
| -h, --help | show the list of commands |
Signing In and Out
| Command | Description |
|---|---|
| login [options] | login to ledgerswarm |
| logout | logout of ledgerswarm |
Pinging your Node
| Command | Description |
|---|---|
| ping [options] | show the current username |
| participantPing [options] | show the current participant |
Accounts
| Command | Description |
|---|---|
| getAccounts [options] | show the accounts |
| setAccounts [options] | set up a new account |
| getAccountPending [options] | show the transactions pending on an account |
Instruments
| Command | Description |
|---|---|
| getInstruments [options] | list all instruments (assets) |
NostroVostro Accounts
| Command | Description |
|---|---|
| getNostroVostro [options] | list all nostro accounts and location of vostro |
Settlement Routes
| Command | Description |
|---|---|
| getRoutes [options] | list all the external settlement routes |
| setRoutes [options] | list all the external settlement routes |
| deleteRoutes [options] | delete an external settlement routes |
Approval Rules
| Command | Description |
|---|---|
| getApproverRules [options] | list all the rules for auto approval |
| setApproverRules [options] | set a new rule for auto approval |
| deleteApproverRules [options] | deleted a rule for auto approval |
Balances
| Command | Description |
|---|---|
| getAccountAssets [options] | show the holdings at an account |
| getAssetBalances [options] | show the holdings of an asset across all accounts |
Proposing Transactions
| Command | Description |
|---|---|
| propose [options] | propose a transaction |
| loadProposal [options] | load a Proposal from file |
| getTransfers [options] | show transfers |
Approving and Rejecting Transactions
| Command | Description |
|---|---|
| approveManifest [options] | approve a manifest |
| rejectManifest [options] | reject a manifest |
Consensus Transactions
| Command | Description |
|---|---|
| consensus [options] | create a consensus transaction and submit to the network |
| approveConsensus [options] | approve a consensus transaction |
| rejectConsensus [options] | reject a consensus transaction |
| getConsensus [options] | show consensus transactions |
| deleteConsensus [options] | delete a consensus transaction |
| getConsensusRules [options] | list all the rules for approval of a consensus transaction |
| setConsensusRules [options] | set a new rule for auto approval |
| deleteConsensusRules [options] | delete a rule for auto approval |
Minting and Burning
| Command | Description |
|---|---|
| mintburn [options] | mint or burn a balance into an account |
Tracing Transaction Routes
| Command | Description |
|---|---|
| trace [options] | trace the route a transaction would take |
Help
| Command | Description |
|---|---|
| help [command] | display help for command |