Commands

Quick help

Use built-in help to discover options and subcommands:

rgbldk --help
rgbldk <command> --help
rgbldk <command> <subcommand> --help

Command map

This page is intentionally short. Each section links to a user-facing guide with examples and gotchas.

• Workflows

  • Transfers (BTC/RGB × L1/L2)

• Reference by area

  • Contexts (ctx ls/show/add/use/rm)
  • Node (node health/ready/status/id/listen/version/lock/unlock/unlock-hosted)
  • Keystore (keystore init/migrate)
  • Wallet (wallet address/sync/balance)
  • Peer (peer ls/connect/disconnect)
  • Channel (channel ls/open/close/force-close)
  • Payments (pay invoice(create/pay/decode/send/hold)/offer/refund/keysend + ls/wait/get/abandon)
  • RGB (rgb sync/address/utxos/issuers/contracts(known)/consignments/ln(create-for-hash)/onchain(invoice-create/invoice-decode/payments/send/receive))
  • Events (events next/handled/watch)
  • Debug (debug invoice/consignment)

Global flags (recap)

See ./overview for the detailed explanation.

rgbldk --connect http://<host>:8501 \
  --token <token> | --token-stdin | --token-file <path> \
  --output text|json|auto --pretty \
  --color auto|always|never \
  --data-dir <path> --control-socket <path> \
  --yes --no-truncate \
  <command...>