Lexe CLI

curl -fsSL https://lexe.app/install-cli.sh | bash

lexe init

lexe node-info

Lexe CLI - Create and control Lightning wallets from the command line.
   Lexe wallets are self-custodial and always online to receive payments.

Create a new mainnet wallet:
  $ lexe init
  The seedphrase is saved to ~/.lexe/seedphrase.txt and auto-loaded on
  subsequent runs. Be sure to back up your seedphrase to a safe place.

Control a wallet created from the Lexe mobile app:
  Export credentials from the app (Menu > SDK clients), then set via:
    • LEXE_CLIENT_CREDENTIALS     Set in environment or .env file
    • --client-credentials        Pass directly in CLI
    • --client-credentials-path   Path to file with client credentials

Verify your setup:
  $ lexe node-info

Precedence: CLI args > env vars > .env
  `.env` is loaded from the current or any parent directory.

Usage: $ lexe [OPTIONS] <COMMAND>

Commands:
  init                  Create a new Lexe wallet
  signup                Register with Lexe and perform initial provisioning
  provision             Provision wallet to latest enclave releases
  node-info             Get information about this Lexe node
  analyze               Get information about a Bitcoin or Lightning payment string
  pay                   Pay a Bitcoin or Lightning payment string
  create-invoice        Create a BOLT 11 invoice to receive a Lightning payment
  pay-invoice           Pay a BOLT 11 invoice over Lightning
  create-offer          Create a BOLT 12 offer to receive Lightning payments
  pay-offer             Pay a BOLT 12 offer over Lightning
  get-payment           Get a payment by its created index
  wait-for-payment      Wait for a payment to reach a terminal state
  update-personal-note  Update the personal note on an existing payment
  sync-payments         Sync payments from the node to the local payments cache
  list-payments         List payments from local storage
  clear-payments        Clear all locally cached payment data for this wallet
  help                  Print this message or the help of the given subcommand(s)

Options:
      --network <NETWORK>
          The bitcoin network to use. [default: mainnet]

          [env: LEXE_NETWORK=]
          [possible values: mainnet, testnet3, regtest]

      --client-credentials <CLIENT_CREDENTIALS>
          The client credentials string exported from the Lexe app. [env: LEXE_CLIENT_CREDENTIALS]

      --client-credentials-path <CLIENT_CREDENTIALS_PATH>
          Path to a file containing the client credentials. [env: LEXE_CLIENT_CREDENTIALS_PATH]

      --root-seed <ROOT_SEED>
          Root seed as a 64-character hex string. [env: LEXE_ROOT_SEED]

      --root-seed-path <ROOT_SEED_PATH>
          Path to a file containing the root seed (hex or mnemonic). [env: LEXE_ROOT_SEED_PATH]

      --lexe-data-dir <LEXE_DATA_DIR>
          Data directory for persisted state. [default: ~/.lexe] [env: LEXE_DATA_DIR]

      --rust-log <RUST_LOG>
          Log level: error, warn, info, debug, trace. [default: info] [env: RUST_LOG]

      --without-db
          Use wallet without local payments persistence

  -h, --help
          Print help (see a summary with '-h')

Creates a new Lexe wallet.

Generates a fresh seedphrase, persists it to the Lexe data dir,
registers a wallet with Lexe, and provisions a new user node.

Idempotent: safe to call multiple times.

Usage: $ lexe init

Options:
  -h, --help
          Print help (see a summary with '-h')

Register with Lexe and perform initial provisioning.
Requires the root seed.

This command exists mostly to support specialized flows.
`lexe init` is usually what you want instead.

Idempotent: safe to call even if already signed up.

Usage: $ lexe signup [OPTIONS]

Options:
      --partner-pk <PARTNER_PK>
          Partner public key (hex) to earn a share of this wallet's fees

  -h, --help
          Print help (see a summary with '-h')

Ensure the wallet is provisioned to all recent trusted releases.

Should be called every time the wallet is loaded to ensure the node
is running the most up-to-date enclave software.

Idempotent: safe to call multiple times.

Usage: $ lexe provision

Options:
  -h, --help
          Print help (see a summary with '-h')

Get information about this Lexe node

Usage: $ lexe node-info

Options:
  -h, --help  Print help

Get information about a Bitcoin or Lightning payment string and its
constituent payment methods (if any). Returned information includes the
type of payment method used (invoice, offer, onchain, lnurl) and the amount
constraints requested by the receiver.

Also provides the specific payment string <payable> that can be used
to pay via the associated payment method using
  $ lexe pay <payable>

Payment methods are returned in order of most to least recommended.

Usage: $ lexe analyze [OPTIONS] <PAYABLE>

Arguments:
  <PAYABLE>
          The Bitcoin or Lightning payment string to analyze

Options:
      --json
          Display output as JSON

  -h, --help
          Print help (see a summary with '-h')

Pay any string which encodes a Bitcoin or Lightning payment method.

If there exist multiple encoded payment methods, one best recommended
payment method will be chosen.

For finer control over how to pay, consider first using
  $ lexe analyze
to resolve the contents of the payable string, then invoking the specific
pay command for the payment method of choice:
  $ lexe pay-offer ...
  $ lexe pay-invoice ...
etc.

Usage: $ lexe pay [OPTIONS] <PAYABLE>

Arguments:
  <PAYABLE>
          The string to be paid

Options:
      --json
          Display output as JSON

      --amount-sats <AMOUNT_SATS>
          Amount in satoshis.
          Optional for payable string with encoded amounts.

      --personal-note <PERSONAL_NOTE>
          Personal note stored locally, not visible to receiver.
          Maximum length: 200 chars / 512 UTF-8 bytes.

      --message <MESSAGE>
          Message sent to the receiver with the payment.

          Supported only if sending to BOLT 12 offers, HBAs pointing to offers,
          LNURL recipients whose wallets accept LUD-12 comments, and Lightning
          Addresses of wallets that accept LUD-12 comments.

          If the payable doesn't support payer notes, this note will be ignored.

          Maximum length: 200 chars / 512 UTF-8 bytes.

  -h, --help
          Print help (see a summary with '-h')

Create a BOLT 11 invoice to receive a Lightning payment

Usage: $ lexe create-invoice [OPTIONS]

Options:
      --amount-sats <AMOUNT_SATS>            Amount in satoshis.
                                             Omit for amountless invoice.
      --description <DESCRIPTION>            Description to encode in invoice.
                                             Visible to sender when scanned.
      --expiration-secs <EXPIRATION_SECS>    Invoice expiration in seconds.
                                             [default: 86400 = 1 day]
      --partner-pk <PARTNER_PK>              Partner user_pk for
                                             partner-set fees. Required for
                                             partner_prop_fee and
                                             partner_base_fee to take effect.
      --partner-prop-fee <PARTNER_PROP_FEE>  Partner proportional fee in ppm.
                                             Required if partner_pk is set.
                                             Min: 5000 (0.5%),
                                             Max: 500000 (50%)
      --partner-base-fee <PARTNER_BASE_FEE>  Partner base fee in satoshis.
                                             Requires amount_sats
                                             to also be set.
  -h, --help                                 Print help

Pay a BOLT 11 invoice over Lightning

Usage: $ lexe pay-invoice [OPTIONS] <INVOICE>

Arguments:
  <INVOICE>  The BOLT 11 invoice to pay

Options:
      --fallback-amount-sats <FALLBACK_AMOUNT_SATS>
          Amount to pay if invoice has no amount.
          Required for amountless invoices.
      --personal-note <PERSONAL_NOTE>
          Personal note (not visible to receiver, max 200 chars)
  -h, --help
          Print help

Create a BOLT 12 offer to receive Lightning payments.

Unlike invoices, offers are reusable: multiple payments can be
made to it, including from multiple payers.

Usage: $ lexe create-offer [OPTIONS]

Options:
      --description <DESCRIPTION>
          Description shown to payers when they scan the offer.
          Maximum length: 512 UTF-8 bytes.

      --min-amount-sats <MIN_AMOUNT_SATS>
          Minimum payment amount in satoshis.
          If not set, the payer can send any amount.

      --expiration-secs <EXPIRATION_SECS>
          Offer expiration in seconds from now

  -h, --help
          Print help (see a summary with '-h')

Pay a BOLT 12 offer over Lightning

Usage: $ lexe pay-offer [OPTIONS] --amount-sats <AMOUNT_SATS> <OFFER>

Arguments:
  <OFFER>
          The BOLT 12 offer to pay

Options:
      --amount-sats <AMOUNT_SATS>
          The amount to pay in satoshis.
          Must satisfy the offer's minimum amount if set.

      --message <MESSAGE>
          Note sent to the receiver with the payment.

          Maximum length: 512 UTF-8 bytes.

      --personal-note <PERSONAL_NOTE>
          Personal note stored locally, not visible to receiver.
          Maximum length: 512 UTF-8 bytes.

  -h, --help
          Print help (see a summary with '-h')

Get a payment by its created index.

Fetches the payment directly from the user node (not from local storage).

Usage: $ lexe get-payment <INDEX>

Arguments:
  <INDEX>
          The payment's created index

Options:
  -h, --help
          Print help (see a summary with '-h')

Wait for a payment to reach a terminal state (completed or failed).

Polls the node with exponential backoff until the payment finalizes
or the timeout is reached. Defaults to 600 seconds (10 minutes).

If already finalized, we still fetch the payment
to ensure we have the latest metadata.

Usage: $ lexe wait-for-payment [OPTIONS] <INDEX>

Arguments:
  <INDEX>
          The payment index to wait on

Options:
      --timeout-secs <TIMEOUT_SECS>
          Timeout in seconds. [default: 600, max: 86400]

  -h, --help
          Print help (see a summary with '-h')

Update the personal note on an existing payment.

The note is stored on the user node and is not visible to the counterparty.

Usage: $ lexe update-personal-note [OPTIONS] <INDEX>

Arguments:
  <INDEX>
          The payment index

Options:
      --personal-note <PERSONAL_NOTE>
          The new personal note (omit to clear, max 200 chars)

  -h, --help
          Print help (see a summary with '-h')

Sync payments from the user node to the local payments cache.

Usage: $ lexe sync-payments

Options:
  -h, --help
          Print help (see a summary with '-h')

List payments from local storage with cursor-based pagination.

Defaults to descending order (newest first) with a limit of 100.
Use `sync-payments` to fetch the latest data from the node first.

Usage: $ lexe list-payments [OPTIONS]

Options:
      --filter <FILTER>
          Filter: all, pending, completed, failed, finalized. [default: all]

          [default: all]

      --order <ORDER>
          Sort order: asc or desc. [default: desc]

      --limit <LIMIT>
          Max number of payments to return. [default: 100]

      --after <AFTER>
          Start after this payment index (for pagination)

  -h, --help
          Print help (see a summary with '-h')

Clear all locally cached payment data for this wallet.

Remote data on the node is not affected.
Use `sync-payments` to re-populate after clearing.

Usage: $ lexe clear-payments

Options:
  -h, --help
          Print help (see a summary with '-h')