Getting Started

Install

With pipx (recommended):

pipx install xrpl-lab

Or with pip:

pip install xrpl-lab

Requires Python 3.11+.

Start learning

The guided launcher walks you through wallet setup, funding, and your first module:

xrpl-lab start

Offline mode

No internet required. Use dry-run for simulated transactions:

xrpl-lab start --dry-run

All commands support --dry-run where applicable, letting you learn the workflow without touching the network.

Verify your installation

After installing, confirm everything works:

xrpl-lab --version
xrpl-lab doctor

The doctor command checks your wallet, state file, workspace, RPC endpoint, and faucet connectivity. It reports actionable hints for anything that needs attention.

What happens on first run

1. xrpl-lab start launches the guided launcher
2. If an XRPL Camp certificate is detected, you can reuse that wallet
3. You create a wallet (stored locally in ~/.xrpl-lab/wallet.json)
4. The faucet funds your testnet wallet
5. You choose a module and work through it
6. Each module produces a verifiable artifact (transaction ID, report, etc.)

Data storage

All state lives locally:

• Wallet — ~/.xrpl-lab/wallet.json (with restrictive file permissions)
• Progress — ~/.xrpl-lab/state.json (module status, transaction IDs)
• Workspace — ./.xrpl-lab/ in the current directory for module outputs

Network usage

• XRPL Testnet RPC — public endpoint, transactions signed locally before submission
• Testnet faucet — public HTTP, only your address is sent
• Both endpoints are overridable via environment variables:
  • XRPL_LAB_RPC_URL — custom RPC endpoint
  • XRPL_LAB_FAUCET_URL — custom faucet endpoint
• Both are optional with --dry-run