Command Reference

Root Command

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

Global options

Option	Meaning
`--json`	Emit raw JSON
`--agent`	Disable prompts for non-interactive use
`--node-url`	Override the configured node URL
`--api-url`	Override the configured API URL
`--install-completion`	Install shell completion
`--show-completion`	Print shell completion

There is no --version flag. Global flags go before the sub-command: kaleido --json market pairs, not kaleido market pairs --json.

Top-Level Commands

Command	Summary
`setup`	First-run configuration and optional local node creation
`node`	Docker-backed RLN environment lifecycle and wallet access
`wallet`	BTC wallet operations
`asset`	RGB asset management and issuance
`channel`	Channel management and LSP order flows
`peer`	Peer connectivity
`payment`	Lightning and RGB+LN payments
`market`	Market discovery, quotes, and routes
`swap`	Maker-backed atomic swap flows
`config`	Stored CLI configuration

`setup`

Command	Notes
`kaleido setup`	Non-interactive default: creates and starts one local mutinynet node with defaults
`kaleido setup signetcustom`	Same flow on an explicit network (positional argument, default `mutinynet`)
`kaleido setup mutinynet --env-name taker-1`	Custom environment name
`kaleido setup --mode market --defaults`	Market-only setup
`kaleido setup --mode local --create-node --defaults`	Local node setup

Key flags: --mode, --defaults, --api-url, --node-url, --create-node, --spawn-dir, --env-name, --node-count, --start

`node`

Command	Summary
`kaleido node create [name]`	Create a named environment
`kaleido node list`	List 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 (`--no-follow` prints existing logs and exits)
`kaleido node clean <name>`	Delete volumes (`--yes` skips the confirmation prompt)
`kaleido node info`	Show node details
`kaleido node network`	Show network information
`kaleido node init`	Initialize the wallet
`kaleido node unlock`	Unlock the wallet (`--chain-sync block\|transaction`, `--bitcoind-*`, `--indexer-url`, `--proxy-endpoint`, `--announce-alias`, `--announce-address`)
`kaleido node lock`	Lock the wallet
`kaleido node shutdown`	Gracefully shut down the node

`node swap`

Command	Summary
`kaleido node swap pubkey`	Print the taker public key
`kaleido node swap init`	Start a local maker-init swap flow (`--from-asset`, `--qty-from`, `--to-asset`, `--qty-to`, `--timeout`)
`kaleido node swap whitelist --swapstring '<swapstring>'`	Whitelist a swap on the taker side
`kaleido node swap execute`	Execute a local node swap (`--swapstring`, `--payment-secret`, `--taker-pubkey`)
`kaleido node swap status <payment-hash>`	Check local node swap status (`--taker` or `--maker`)
`kaleido node swap list`	List swaps known to the node

`wallet`

Command	Summary
`kaleido wallet address`	New BTC deposit address
`kaleido wallet balance`	BTC balance (`--skip-sync`)
`kaleido wallet send <amount> <address>`	Send BTC (`--fee-rate`, `--skip-sync`)
`kaleido wallet utxos`	List UTXOs (`--skip-sync`)
`kaleido wallet create-utxos`	Create UTXOs for RGB usage (`--num/-n`, `--size`, `--up-to`, `--fee-rate`, `--skip-sync`)
`kaleido wallet transactions`	Transaction history
`kaleido wallet backup <path>`	Backup wallet data
`kaleido wallet restore <path>`	Restore wallet data
`kaleido wallet change-password`	Change wallet password (`--old-password`, `--new-password`)
`kaleido wallet estimate-fee`	Estimate fee rate (`--blocks/-b`, default 6)

`asset`

Command	Summary
`kaleido asset list`	List assets
`kaleido asset balance <asset-id>`	Asset balance
`kaleido asset metadata <asset-id>`	Asset metadata
`kaleido asset invoice <asset-id>`	Create an RGB invoice (`--amount/-a`, `--min-confirmations`, `--duration`, `--transport-endpoint`)
`kaleido asset send <asset-id> <amount> <invoice>`	Send RGB assets (`--fee-rate`, `--min-confirmations`, `--donation`, `--transport-endpoint`, `--witness-amount-sat`, `--witness-blinding`, `--skip-sync`)
`kaleido asset send-batch <json-file>`	Send to many recipients, from a JSON file
`kaleido asset transfers <asset-id>`	Transfer history
`kaleido asset refresh`	Refresh pending transfers (`--skip-sync`)
`kaleido asset sync`	Sync RGB wallet
`kaleido asset fail-transfers`	Mark pending transfers as failed (`--batch-idx`, `--no-asset-only`, `--skip-sync`)
`kaleido asset media <digest>`	Fetch asset media by SHA-256 digest

`asset issue`

Command	Summary
`kaleido asset issue nia`	Issue a fixed-supply fungible asset
`kaleido asset issue cfa`	Issue a collectible fungible asset
`kaleido asset issue uda`	Issue a unique digital asset

All issue subcommands accept --precision for the number of decimal places, and express --supply in the smallest raw unit. cfa and uda also accept --description and --file.

`channel`

Command	Summary
`kaleido channel list`	List channels
`kaleido channel open <peer>`	Open a channel (`--capacity/-c`, `--push-msat`, `--asset-id`, `--asset-amount`, `--push-asset-amount`, `--public/--private`, `--with-anchors`, `--fee-base-msat`, `--fee-proportional-millionths`, `--temporary-channel-id`)
`kaleido channel close <channel-id>`	Close a channel (requires `--peer <pubkey>`; `--force` for a unilateral close)

`channel order`

Command	Summary
`kaleido channel order create [client-pubkey]`	Create an LSP channel order (pubkey defaults to the local node; `--yes` accepts the fetched RFQ price)
`kaleido channel order get <order-id>`	Fetch order status (`--access-token`)
`kaleido channel order pay <order-id>`	Pay for a channel order (`--access-token`; non-interactively pass `--onchain` or `--offchain`, plus `--fee-rate` and `--yes`)
`kaleido channel order decide <order-id>`	Submit a rate decision (`--accept` or `--reject`, `--access-token`)
`kaleido channel order estimate-fees`	Estimate channel-order fees (`--lsp-balance`, `--client-balance`, `--asset-id`, `--lsp-asset-amount`, `--client-asset-amount`, `--expiry-blocks`, `--token`, `--rfq-id`)

`channel lsp`

Command	Summary
`kaleido channel lsp info`	LSP metadata and options
`kaleido channel lsp network-info`	LSP network information

`peer`

Command	Summary
`kaleido peer list`	List peers
`kaleido peer connect <peer>`	Connect to a peer
`kaleido peer disconnect <pubkey>`	Disconnect from a peer

`payment`

Command	Summary
`kaleido payment invoice`	Create a BOLT11 or RGB+LN invoice (`--expiry`, default 3600)
`kaleido payment send <invoice>`	Pay an invoice
`kaleido payment list`	List payments
`kaleido payment status <payment-hash>`	Payment status
`kaleido payment decode <invoice>`	Decode an invoice
`kaleido payment invoice-status <invoice>`	Invoice status
`kaleido payment keysend <dest-pubkey> <amt-msat>`	Spontaneous Lightning payment (`--asset-id`/`--asset-amount` for RGB)

`market`

Command	Summary
`kaleido market assets`	List assets
`kaleido market pairs`	List pairs
`kaleido market quote <pair>`	Request a quote (`--from-amount`/`--to-amount`, `--from-layer`, `--to-layer`)
`kaleido market info`	Maker node information
`kaleido market routes <pair>`	Available routes

`swap`

`swap atomic`

Command	Summary
`kaleido swap atomic init <pair>`	Initialize an atomic swap (`--from-amount`/`--to-amount`, `--from-layer`, `--to-layer`, `--yes/-y`)
`kaleido swap atomic execute`	Execute the swap (`--swapstring`, `--taker-pubkey`, `--payment-hash`, prompted if omitted; `--auto-whitelist` whitelists on the local node first)
`kaleido swap atomic status <payment-hash>`	Atomic swap status
`kaleido swap atomic run <pair>`	Run the full atomic flow

`config`

Command	Summary
`kaleido config show`	Print current config
`kaleido config set <key> <value>`	Update one config key
`kaleido config reset`	Reset config to defaults (`--yes/-y`)
`kaleido config path`	Print config file path

Valid config keys: node-url, api-url, network, spawn-dir

Amounts And Layers

Commands	Amount unit
`market quote`, `swap atomic init`, `swap atomic run`	Display units — `--from-amount 0.001` is 0.001 BTC
`asset invoice`, `asset send`, `payment *`	Raw integer units, per the asset’s precision
`wallet send`, `wallet create-utxos`, `channel open --capacity`	Satoshis

Layer values also differ by command: market quote accepts BTC_LN, RGB_LN, and BTC_ONCHAIN, while swap atomic init and swap atomic run accept BTC_L1, BTC_LN, RGB_L1, and RGB_LN.

Short Aliases

Alias	Option	Used by
`-p`	`--password`	`node init`, `node unlock`, `wallet backup`, `wallet restore`
`-y`	`--yes`	`node clean`, `config reset`, `channel order create`, `channel order pay`, `swap atomic init`, `swap atomic run`
`-n`	`--node` / `--num`	`node use` / `wallet create-utxos`
`-s`	`--service`	`node logs`
`-c`	`--capacity`	`channel open`
`-a`	`--amount` / `--amount-msat`	`asset invoice` / `payment invoice`
`-e`	`--expiry`	`payment invoice`
`-b`	`--blocks`	`wallet estimate-fee`

Machine-Readable Mode

Every command group can be combined with --json:

kaleido --json wallet balance
kaleido --json market quote BTC/USDT --from-amount 0.001

Pair it with --agent in scripts so a missing value fails fast instead of waiting on a prompt, and add --yes to anything that spends funds or accepts a price. See Troubleshooting.

Introduction

Node Operations

Channels & Trading

Reference

Root Command

Global options

Top-Level Commands

`setup`

`node`

`node swap`

`wallet`

`asset`

`asset issue`

`channel`

`channel order`

`channel lsp`

`peer`

`payment`

`market`

`swap`

`swap atomic`

`config`

Amounts And Layers

Short Aliases

Machine-Readable Mode

​Root Command

​Global options

​Top-Level Commands

​setup

​node

​node swap

​wallet

​asset

​asset issue

​channel

​channel order

​channel lsp

​peer

​payment

​market

​swap

​swap atomic

​config

​Amounts And Layers

​Short Aliases

​Machine-Readable Mode

Root Command

Global options

Top-Level Commands

`setup`

`node`

`node swap`

`wallet`

`asset`

`asset issue`

`channel`

`channel order`

`channel lsp`

`peer`

`payment`

`market`

`swap`

`swap atomic`

`config`

Amounts And Layers

Short Aliases

Machine-Readable Mode