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/Installation

CLI

Installing the FurlPay CLI

Install @furlpay/cli 0.4.0 with npm, a verified install script for macOS/Linux or Windows, or offline from the signed release tarball. No administrator or root privileges are needed.

Requirements

Node.js ≥ 22.19.0 (npm ships with it). Linux, macOS and Windows are supported. Verify with node --version before installing; the CLI checks the version at startup and refuses to run unsupported Node.

npm — recommended

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

npm is the supported installation channel. Global installs are integrity-checked by the registry (sha512 + signatures) and the package publishes with npm provenance bound to the FurlPay/furlpay-cli repository and release workflow.

npx — no global install

bash
npx @furlpay/cli --help

Runs the CLI without installing it. npx fetches the package from the registry each run unless cached; prefer a global install for anything recurring or automated.

Install scripts

The scripts verify Node and npm, warn on unofficial registry mirrors, never use sudo or elevation, install per-user, and verify the installed version afterwards. Both accept pinning (--version X.Y.Z / -Version), the beta channel (--channel beta / -Channel), a dry run, and uninstall.

# Inspect the script first — piping a remote script to a shell
# without reading it is a supply-chain risk you do not need.
curl -fsSL https://raw.githubusercontent.com/FurlPay/furlpay-cli/main/install.sh -o install-furlpay.sh
less install-furlpay.sh

sh install-furlpay.sh
# or, pinned:
sh install-furlpay.sh --version 0.4.0 --dry-run

Inspect remote install scripts before executing them

The one-liners below are shown for convenience, but the safer habit is to download, read, then run — which is what the tabs above show. Piping a URL straight into a shell means whatever the URL returns that minute runs with your user's privileges.
bash
curl -fsSL https://raw.githubusercontent.com/FurlPay/furlpay-cli/main/install.sh | sh
irm https://raw.githubusercontent.com/FurlPay/furlpay-cli/main/install.ps1 | iex

Other package managers

bash
pnpm add -g @furlpay/cli
yarn global add @furlpay/cli
bun install -g @furlpay/cli

Offline install from the release tarball

Each GitHub release publishes the exact npm tarball plus checksums.txt, a CycloneDX SBOM, and sigstore build-provenance attestations. Verify first, then install from the verified file:

bash
sha256sum -c checksums.txt --ignore-missing
gh attestation verify --repo FurlPay/furlpay-cli @furlpay/cli-0.4.0.tgz
npm install -g ./@furlpay/cli-0.4.0.tgz

Standalone binaries

Standalone binaries (no Node.js required) are not yet available. If a page or mirror offers you a furlpay binary, it is not from this project — npm is the only supported channel, and this page will list binaries with checksums and attestations only once they actually ship.

Keeping it current

bash
furlpay update --check        # read-only check against npm
furlpay update                # self-update (npm installs), with confirmation
furlpay doctor                # install method, registry, config, connectivity

Updates are installation-method aware, transmit no credentials, and never touch ~/.furlpay (config, wallets, the escrow ledger). Roll back by pinning the previous version:

bash
npm install -g @furlpay/cli@<previous-version>

Uninstall

bash
npm uninstall -g @furlpay/cli
  • The install scripts' uninstall mode (--uninstall / -Uninstall) removes the binary and, with confirmation, the ~/.furlpay directory.
  • ~/.furlpay holds your config, encrypted keystore and escrow ledger — deleting it removes every locally stored wallet and escrow record irreversibly.
Did this page help?
Edit this page on GitHub

← Previous

FurlPay CLI

Next →

CLI Quickstart