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, create maker swap orders, run 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, place maker orders, and run atomic or local swap flows.
Global Flags
All command groups inherit the same root flags:| Flag | Purpose |
|---|---|
--json | Return raw JSON instead of rich terminal output |
--agent | Disable interactive prompts for scripted or agent-driven use |
--node-url | Override the configured RGB Lightning Node URL for one command |
--api-url | Override the configured KaleidoSwap API URL for one command |
--install-completion | Install shell completion for the current shell |
--show-completion | Print shell completion for manual setup |
Environment Variables
The CLI also reads these environment variables:| Variable | Use |
|---|---|
KALEIDO_NODE_URL | Default RLN node URL |
KALEIDO_API_URL | Default KaleidoSwap API URL |
Command Groups
| Group | Purpose |
|---|---|
setup | First-run setup for market-only or local-node use |
node | Environment lifecycle, wallet initialization, unlock, and taker operations |
wallet | BTC balance, addresses, sends, UTXOs, fees, backup, and restore |
asset | RGB assets, issuance, invoices, sends, transfer history, and sync |
channel | Lightning channels plus LSP-backed channel ordering |
peer | Peer discovery and connectivity |
payment | Lightning invoices, sends, keysend, decode, and status |
market | Assets, pairs, routes, quotes, maker info, and analytics |
swap | Maker order flow, maker atomic flow, and local node swap flow |
config | Stored CLI configuration in ~/.kaleido/config.json |
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.