KaleidoCLI: Getting Started

This is the path from an installed CLI to your first commands. If you have not installed it yet, start with Installation.

First-Run Setup

For new users, start with:

kaleido setup

Bare kaleido setup runs non-interactively: it immediately creates and starts a local Docker mutinynet node with default settings, so Docker must be running. The Bitcoin network is an optional positional argument (default mutinynet):

kaleido setup signetcustom
kaleido setup mutinynet --env-name taker-1

Use --mode to select a profile explicitly:

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

Flag	Purpose
`<network>` (positional)	Bitcoin network for the local node, default `mutinynet`
`--mode market\|local`	Choose the setup profile
`--defaults`	Use saved or default values instead of prompting
`--api-url`	Save the KaleidoSwap API base URL
`--node-url`	Save a node URL directly
`--create-node`	Create a Docker node environment during setup
`--spawn-dir`	Set the base directory for named environments
`--env-name`	Name the environment created during setup
`--node-count`	Number of nodes to create
`--start`	Start 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.signet.kaleidoswap.com
kaleido config set network signet
kaleido config set spawn-dir ~/.kaleido
kaleido config path

Quick Start

Market-only

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

Local node

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

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.

Introduction

Node Operations

Channels & Trading

Reference

First-Run Setup

Non-interactive examples

Setup flags

Configuration

Quick Start

Market-only

Local node

When To Override Config

​First-Run Setup

​Non-interactive examples

​Setup flags

​Configuration

​Quick Start

​Market-only

​Local node

​When To Override Config

First-Run Setup

Non-interactive examples

Setup flags

Configuration

Quick Start

Market-only

Local node

When To Override Config