Named Environment Model
kaleido node manages named Docker Compose environments stored under a base directory, which defaults to:
rgb_node_<n> service with its own data volume. Only the node itself runs locally: bitcoind, the indexer, and the RGB proxy are remote services.
Create An Environment
- Base directory
- Environment name
- Node count
- Bitcoin network
- Base daemon and peer ports
- Whether to start the environment immediately
Lifecycle Commands
When exactly one environment exists, commands like
up, stop, logs, and clean can auto-detect it.
Switch The Active Node
Usekaleido node use to update the configured node URL:
kaleido node list marks the active node with ●.
This is the bridge between Docker-managed environments and all node-dependent commands such as wallet, asset, channel, and payment.
Initialize And Unlock
After a fresh environment starts, initialize the wallet once:--passwordto pass the wallet password directly--mnemonicto restore from an existing mnemonic during initialization
Chain sync mode
With
transaction, every --bitcoind-* option is ignored:
Unlock options
By default the command uses the KaleidoSwap signet services. For a scripted unlock, pass the password explicitly and disable prompts:
Inspect And Lock
info to confirm the node is reachable and correctly configured before running wallet, channel, or swap flows.
Node Swap Operations
The nestedswap group supports atomic and low-level swap operations on the node side:
Recommended Local Flow
Operational Notes
cleanis irreversible because it removes the underlying data volumes.downremoves containers and networks, but preserves volumes.logsaccepts--serviceto limit output to one container.