KaleidoCLI

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.

The same binary supports both interactive terminal use and scripted automation.

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

Example:

kaleido --json market pairs
kaleido --node-url http://localhost:3001 wallet balance
kaleido --agent channel open 03ab...@host:9735 --capacity 100000

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-line flags take precedence over environment variables and stored config.

Command Groups

Work is split across ten groups. Each one is documented subcommand by subcommand, with its arguments and flags, in Commands — this table is the map of what you will find there.

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, and maker info
`swap`	Maker-backed atomic swap flow (init, execute, status, run); local node swap steps live under `node swap`
`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:

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

Use --agent when the command must fail instead of prompting for missing input.

Introduction

Node Operations

Channels & Trading

Reference

What The CLI Covers

Global Flags

Environment Variables

Command Groups

Output Modes

​What The CLI Covers

​Global Flags

​Environment Variables

​Command Groups

​Output Modes

What The CLI Covers

Global Flags

Environment Variables

Command Groups

Output Modes