FurlPay Docs
Open App
  • Services & Availability
  • Quickstart
  • For AI Agents
  • FurlPay CLInew
  • Installationnew
  • CLI Quickstartnew
  • MCP Server & Agent Securitynew
  • Tradingnew
  • Escrow & Verificationnew
  • Monorepo
  • API Routes
  • Authenticationupdated
  • Webhook Eventsupdated
  • Error Codesupdated
  • Rate Limitsnew
  • Configuration & Setupnew
  • Merchant Paymentsnew
  • Payroll & Payoutsnew
  • Agentic Payments (x402)updated
  • Agent Trust & Mandates (TAP)updated
  • CCTP Cross-Chainupdated
  • LI.FI Swapsupdated
  • FurlPay Travels (Travel MCP)updated
  • Solana Actions & Blinks
  • Settlement Workspacenew
  • FURL Tokennew
  • Claude Connectorupdated
  • AI Assistants
  • Circlenew
  • Ramp Providersnew
  • Telegram Mini Appnew
  • Stripe Crypto
  • Persona KYC
  • Regulatory status
  • Screening & Casesnew
  • Security Postureupdated
  • Signing & WebAuthnupdated
  • Help Center
  • Getting Started
  • KYC Verification
  • Passkeys & Biometrics
  • Privacy & Data Protection
  • Transaction Statuses
  • Gasless Transfers
  • Deposits & Withdrawals
  • Managing Virtual Cards
  • Freezing & Unfreezing Cards
  • Declined Transactions
  • SDK & API Support
  • x402 Monetization Basics
  • Booking Travel
  • Travel Refunds & Cancellations

Resources

  • Changelog
  • System Status
  • OpenAPI Spec
  • Community
  • GitHub
Docs/CLI/CLI Quickstart

CLI

CLI quickstart

From install to a working first session: verify the tool, check your environment, validate configuration, fund a testnet account, and connect an AI agent — without touching mainnet value on the way.

Order matters on purpose

The first steps are all verification. The CLI fails closed on missing configuration and refuses to fabricate outcomes (a faucet claim without Friendbot's response, a funding hash you did not supply), so running diagnostics first tells you exactly which surfaces will be live for you.

1 · Install and verify

bash
npm install -g @furlpay/cli
furlpay --version

2 · Run diagnostics

bash
furlpay doctor            # human-readable
furlpay doctor --output json   # machine-readable; exit 1 when the API is unreachable

Reports install method, registry, local config and connectivity. The JSON mode exits non-zero when the connectivity check fails, so scripts and CI can rely on it.

3 · Validate your configuration

bash
furlpay config validate

Local structural checks only: canonical network passphrases, https endpoints, slippage and risk bounds, and agent-trust cap consistency (a single-transaction cap may not exceed the daily cap). Non-zero exit on any error.

4 · Connect a wallet

furlpay wallet connect ledger --derivation-index 0
bash
furlpay wallet list

5 · Look at the networks you can reach

bash
furlpay hyperliquid status    # validator connectivity, active universe, HLP vault
furlpay balance               # balances across Arbitrum, Base, Optimism, Ethereum

Hyperliquid market data is live; hosted FurlPay balances require an authenticated session (furlpay login). The CLI reports what it can actually reach — it does not present unreachable networks as available.

6 · Query live market data

bash
furlpay market BTC                      # L2 book, depth bands, OFI, micro-price
furlpay market BTC --slippage 0.5 --side buy
furlpay hyperliquid markets             # perp universe: mark, funding, open interest

7 · Fund a testnet account (real Friendbot, no mainnet)

bash
furlpay faucet --address G... --network testnet

The faucet works on testnet and futurenet only — mainnet is refused outright. FUNDED is reported only on the Friendbot's own success response plus an independent Horizon balance check, with the funding transaction hash.

8 · Verify a transaction honestly

bash
furlpay tx verify <64-hex-hash> --network testnet --output json

Returns one of five outcomes: CONFIRMED_SUCCESS, CONFIRMED_FAILED, NOT_FOUND (explicitly not proof of absence), INVALID_HASH, UNAVAILABLE. Exit 0 only means confirmed success.

9 · Configure an agent key

bash
furlpay wallet agent-keygen \
  --name agent-alpha \
  --daily-limit 50.00 \
  --allowed-assets USDC,JQQQ,FOBXX \
  --expiry 7d

A delegated session key with a spending policy: daily cap, allowed assets, expiry. Policy enforcement happens before every gated tool call and fails closed. Details and the MCP wiring: MCP server & agent security.

10 · Connect the MCP server

bash
furlpay mcp --wallet agent-alpha
  • Add the server to Claude Desktop or Cursor — the exact config and the full tool list with per-tool status are on the MCP page.
  • For the hosted FurlPay MCP endpoint (a different surface — the web account, not the CLI), see Claude Connector.

Where you deliberately did not go

No Stellar order was placed (that flow is a labeled local simulation in this build), no x402 invoice was really settled (simulated — no live facilitator), and no escrow contract moved funds (escrow is a local ledger). See the capability matrix for what each surface actually does.
Did this page help?
Edit this page on GitHub

← Previous

Installation

Next →

MCP Server & Agent Security