Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kaleidoswap.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Requirements

  • Python 3.10 or newer
  • uv recommended, or pip
  • Docker and Docker Compose for node commands and any local RLN workflow

​
Installation

​
Install globally with uv

uv tool install git+https://github.com/kaleidoswap/kaleido-cli.git
This installs the kaleido executable without cloning the repository first.

​
Install from a local checkout

git clone https://github.com/kaleidoswap/kaleido-cli
cd kaleido-cli
make install

​
Bootstrap from a checkout

python install.py

​
First-Run Setup

For new users, start with: 
kaleido setup
The setup flow supports two profiles:
  • market: save API settings for market data and server-side swap flows
  • local: configure API settings and optionally create a local Docker node environment

​
Non-interactive examples

# Market-only setup with saved defaults
kaleido setup --mode market --defaults

# Create and start a local node environment with defaults
kaleido setup --mode local --create-node --defaults

​
Setup flags

FlagPurpose
`—mode marketlocal`Choose the setup profile
--defaultsUse saved or default values instead of prompting
--api-urlSave the KaleidoSwap API base URL
--networkSave the Bitcoin network
--node-urlSave a node URL directly
--create-nodeCreate a Docker node environment during setup
--spawn-dirSet the base directory for named environments
--env-nameName the environment created during setup
--node-countNumber of nodes to create
--startStart the environment after it is created

​
Configuration

The CLI stores configuration in: 
~/.kaleido/config.json
Supported keys:
  • api-url
  • node-url
  • network
  • spawn-dir
Example commands: 
kaleido config show
kaleido config set api-url https://api.kaleidoswap.com
kaleido config set network signet
kaleido config set spawn-dir ~/.kaleido/spawn
kaleido config path

​
Quick Start

​
Market-only

kaleido setup --mode market --defaults
kaleido market pairs
kaleido market quote BTC/USDT --from-amount 100000

​
Local node

kaleido setup --mode local --create-node --defaults
kaleido node init
kaleido node unlock
kaleido node info
kaleido wallet address

​
Shell Completion

Install completion for your current shell with: 
kaleido --install-completion
Or print the completion script for manual installation: 
kaleido --show-completion

​
When To Override Config

Stored config is useful for your default environment. Override it per command when needed: 
kaleido --api-url https://api.signet.kaleidoswap.com market pairs
kaleido --node-url http://localhost:3002 wallet balance
Continue to Node Environments if you need to manage multiple local RLN stacks.