Skip to main content

​
Root Command

kaleido [global options] <command> [subcommand] [args]

​
Global options

OptionMeaning
--jsonEmit raw JSON
--agentDisable prompts for non-interactive use
--node-urlOverride the configured node URL
--api-urlOverride the configured API URL
--install-completionInstall shell completion
--show-completionPrint shell completion

​
Top-Level Commands

CommandSummary
setupFirst-run configuration and optional local node creation
nodeDocker-backed RLN environment lifecycle and wallet access
walletBTC wallet operations
assetRGB asset management and issuance
channelChannel management and LSP order flows
peerPeer connectivity
paymentLightning and RGB+LN payments
marketMarket discovery, quotes, and analytics
swapOrder, atomic, and local node swap flows
configStored CLI configuration

​
setup

CommandNotes
kaleido setupInteractive first-run flow
kaleido setup --mode market --defaultsMarket-only setup
kaleido setup --mode local --create-node --defaultsLocal node setup
Key flags: --mode, --defaults, --api-url, --network, --node-url, --create-node, --spawn-dir, --env-name, --node-count, --start

​
node

CommandSummary
kaleido node create [name]Create a named environment
kaleido node listList environments and node URLs
kaleido node use <name> [--node N]Select the active node
kaleido node up <name>Start containers
kaleido node stop <name>Stop containers
kaleido node down <name>Remove containers and networks
kaleido node ps <name>Show container status
kaleido node logs <name>Stream logs
kaleido node clean <name>Delete volumes
kaleido node infoShow node details
kaleido node initInitialize the wallet
kaleido node unlockUnlock the wallet
kaleido node lockLock the wallet

​
node taker

CommandSummary
kaleido node taker pubkeyPrint the taker public key
kaleido node taker whitelist <swapstring>Accept a swap on the taker side

​
wallet

CommandSummary
kaleido wallet addressNew BTC deposit address
kaleido wallet balanceBTC balance
kaleido wallet send <amount> <address>Send BTC
kaleido wallet utxosList UTXOs
kaleido wallet create-utxosCreate UTXOs for RGB usage
kaleido wallet transactionsTransaction history
kaleido wallet backup <path>Backup wallet data
kaleido wallet restore <path>Restore wallet data
kaleido wallet change-passwordChange wallet password
kaleido wallet estimate-feeEstimate fee rate
kaleido wallet shutdownGracefully shut down the node

​
asset

CommandSummary
kaleido asset listList assets
kaleido asset balance <asset-id>Asset balance
kaleido asset metadata <asset-id>Asset metadata
kaleido asset invoice <asset-id>Create an RGB invoice
kaleido asset send <asset-id> <amount> <invoice>Send RGB assets
kaleido asset send-batchSend to many recipients
kaleido asset transfers <asset-id>Transfer history
kaleido asset refreshRefresh pending transfers
kaleido asset syncSync RGB wallet
kaleido asset fail-transfersMark pending transfers as failed
kaleido asset mediaFetch asset media

​
asset issue

CommandSummary
kaleido asset issue niaIssue a fixed-supply fungible asset
kaleido asset issue cfaIssue a collectible fungible asset
kaleido asset issue udaIssue a unique digital asset

​
channel

CommandSummary
kaleido channel listList channels
kaleido channel open <peer>Open a channel
kaleido channel close <channel-id>Close a channel

​
channel order

CommandSummary
kaleido channel order create <client-pubkey>Create an LSP channel order
kaleido channel order get <order-id>Fetch order status
kaleido channel order decide <order-id>Submit a rate decision
kaleido channel order estimate-feesEstimate channel-order fees

​
channel lsp

CommandSummary
kaleido channel lsp infoLSP metadata and options
kaleido channel lsp network-infoLSP network information

​
peer

CommandSummary
kaleido peer listList peers
kaleido peer connect <peer>Connect to a peer
kaleido peer disconnect <pubkey>Disconnect from a peer

​
payment

CommandSummary
kaleido payment invoiceCreate a BOLT11 or RGB+LN invoice
kaleido payment send <invoice>Pay an invoice
kaleido payment listList payments
kaleido payment status <payment-hash>Payment status
kaleido payment decode <invoice>Decode an invoice
kaleido payment invoice-status <invoice>Invoice status
kaleido payment keysendSpontaneous Lightning payment

​
market

CommandSummary
kaleido market assetsList assets
kaleido market pairsList pairs
kaleido market quote <pair>Request a quote
kaleido market infoMaker node information
kaleido market routes <pair>Available routes
kaleido market analyticsOrder analytics

​
swap

​
swap order

CommandSummary
kaleido swap order create <pair>Create a maker swap order
kaleido swap order decide <order-id>Submit a pending rate decision
kaleido swap order status <order-id>Order status
kaleido swap order historyOrder history

​
swap atomic

CommandSummary
kaleido swap atomic init <pair>Initialize an atomic swap
kaleido swap atomic executeExecute the swap
kaleido swap atomic status <payment-hash>Atomic swap status
kaleido swap atomic run <pair>Run the full atomic flow

​
swap node

CommandSummary
kaleido swap node initStart a low-level node swap
kaleido swap node whitelistWhitelist a taker-side swap
kaleido swap node executeExecute the swap
kaleido swap node status <payment-hash>Node swap status
kaleido swap node listList local swaps

​
config

CommandSummary
kaleido config showPrint current config
kaleido config set <key> <value>Update one config key
kaleido config resetReset config to defaults
kaleido config pathPrint config file path
Valid config keys: node-url, api-url, network, spawn-dir

​
Machine-Readable Mode

Every command group can be combined with --json: 
kaleido --json wallet balance
kaleido --json market quote BTC/USDT --from-amount 100000