xrpl-up

xrpl-up

CLI for XRPL local development and scripting. Spin up a local sandbox with pre-funded accounts, run scripts, manage snapshots, and interact with remote testnet/devnet endpoints from one tool.

Prerequisites

• Node.js v18 or later
• Docker (required for --local mode only)

Installation

From npm (global):

npm install -g xrpl-up

Not available yet: package has not been published to npm.

From source (development):

git clone https://github.com/ripple/xrpl-up.git
cd xrpl-up
npm install
npm run build
npm link

Quick Start

# Scaffold a new project (select "local" as default network)
xrpl-up init my-project
cd my-project && npm install

# Start a local sandbox with 10 pre-funded accounts
xrpl-up node --local

# In another terminal — list accounts with live balances
xrpl-up accounts --local

# Run a script against the local sandbox
xrpl-up run scripts/example-payment.ts

# Create an AMM pool in one command
xrpl-up amm create XRP USD --local

# Mint a transferable NFT
xrpl-up nft mint --local --uri https://example.com/meta.json --transferable

# Create an MPT issuance (Multi-Purpose Token)
xrpl-up mptoken issuance create --node ws://localhost:6006 --max-amount 1000000 --asset-scale 6

# Open a payment channel
xrpl-up channel create rDestination... 10 --local

---

Commands

xrpl-up has two command sets:

• Sandbox operation commands: environment lifecycle and state control (node, stop, reset, snapshot, status, accounts, logs, config, run, init, faucet, amendment).
• XRPL interaction commands: transaction submission and account management (wallet, account, payment, trust, offer, amm, nft, mptoken, escrow, check, channel, ticket, clawback, credential, did, multisig, oracle, deposit-preauth, permissioned-domain, vault).

XRPL interaction commands are intentionally non-exhaustive. For complex or production-grade flows, use xrpl.js directly or call rippled RPC endpoints.

⚠️ Mainnet safety: XRPL interaction commands (wallet, account, payment, trust, offer, amm, nft, mptoken, escrow, check, channel, ticket, clawback, credential, did, multisig, oracle, deposit-preauth, permissioned-domain, vault) have no mainnet guard. Passing --node mainnet (or a mainnet WebSocket URL) will submit real transactions. These commands are intended for local and testnet development only.

Global flag: --node

All XRPL interaction commands accept a global --node option that sets the network target:

Value	Connects to
testnet (default)	XRPL Testnet
devnet	XRPL Devnet
mainnet	XRPL Mainnet (caution)
ws://localhost:6006	Local sandbox started with xrpl-up node --local

# Use local sandbox (start first with: xrpl-up node --local)
xrpl-up account info rMyAddress --node ws://localhost:6006

# Use testnet (default)
xrpl-up wallet fund --account rMyAddress

# Set via environment variable
export XRPL_NODE=ws://localhost:6006
xrpl-up payment --to rDest --amount 10

--node only applies to XRPL interaction commands; sandbox lifecycle commands (node, stop, reset, etc.) use their own --local / --network flags.

xrpl-up node

Starts a sandbox environment and funds accounts. Supports a fully local rippled node (via Docker) or a connection to XRPL Testnet/Devnet.

# Local Docker sandbox (recommended)
xrpl-up node --local

# Connect to Testnet
xrpl-up node --network testnet

# Connect to Devnet
xrpl-up node --network devnet

Local mode options:

Flag	Default	Description
--local	—	Run a local rippled node via Docker
--image <image>	xrpllabsofficial/xrpld:latest	rippled Docker image
--persist	off	Keep ledger state and accounts across restarts
--ledger-interval <ms>	1000	Auto-advance ledger every N milliseconds
--no-auto-advance	—	Disable automatic ledger closing
--no-secrets	—	Suppress seeds and private keys from stdout (auto-enabled with --detach)
--debug	—	Enable rippled debug logging
--detach	—	Start in background and exit (for CI/CD)
--config <path>	—	Use a custom rippled.cfg instead of the auto-generated one
--exit-on-crash	—	Exit with code 134 when rippled crashes (SIGABRT); disables container auto-restart
-a, --accounts <n>	10	Number of accounts to pre-fund

What xrpl-up node --local does: