What The CLI Covers
kaleido is the command-line interface for two distinct workflows:
- Local RGB Lightning Node operations: create Docker-backed node environments, initialize and unlock wallets, manage BTC, RGB assets, channels, peers, and Lightning payments.
- KaleidoSwap market and swap flows: inspect market data, request quotes, run maker-backed atomic swaps, and drive low-level local node swap steps.
Why Use It
Guided Setup
Start in market-only mode or provision a local node environment from one setup flow.
Named Environments
Keep multiple local node stacks isolated and switch the active node with one command.
Wallet And RGB Ops
Work with BTC, RGB assets, invoices, transfers, backups, and Lightning payments.
Trading And Swaps
Query pairs and quotes, and run atomic or local node swap flows.
Global Flags
All command groups inherit the same root flags:
Example:
Environment Variables
The CLI also reads these environment variables:
Command-line flags take precedence over environment variables and stored config.
Command Groups
Output Modes
By default,kaleido renders human-readable tables and summaries. For pipelines and automation, prefer --json:
--agent when the command must fail instead of prompting for missing input.
Next Steps
- Start with Getting Started if you are installing the CLI for the first time.
- See Node Environments if you need a local RLN stack.
- Use Command Reference for the full command map.