nebulon-escrow-cli
v0.8.5
Published
Nebulon CLI
Readme
Nebulon CLI
Nebulon CLI is the command-line interface for managing Nebulon escrow contracts, wallets, capsules, and hosted profile actions. It supports MagicBlock ephemeral rollups for contract operations and provides end-to-end contract workflows, including terms, milestones, funding, and claims.
Requirements
- Node.js 18 or newer
- npm 9 or newer
Installation
Global install from npm:
npm install -g nebulon-escrow-cliFrom source:
cd CLI
npm install
npm linkQuick start
nebulon init
nebulon login
nebulon statusThe init flow sets up a capsule, wallet, and network defaults. login connects
to hosted services. Use status to verify connectivity and balances.
Command overview
Run nebulon help for the full list. Common commands:
nebulon init- interactive setup (banner shows the CLI version)nebulon status- account summarynebulon login/nebulon logoutnebulon capsule list/nebulon capsule use <name>nebulon contract ...- create and manage escrow contractsnebulon invite list/nebulon invite <id>nebulon balance/nebulon addressnebulon wallet exportnebulon config/nebulon config <key> <value>
Contract commands (examples)
nebulon contract list
nebulon contract <id> details
nebulon contract <id> add term payment 20
nebulon contract <id> add term deadline 8d
nebulon contract <id> add milestone "Draft spec"
nebulon contract <id> sign
nebulon contract <id> fund
nebulon contract <id> milestone 1 ready
nebulon contract <id> milestone 1 confirm
nebulon contract <id> claim_fundsVerbose diagnostics
Use --verbose on contract commands to show additional progress and routing
details:
nebulon contract <id> fund --verboseConfiguration and storage
By default, configuration and wallets are stored under:
- Windows:
%USERPROFILE%\\.nebulon\\ - macOS/Linux:
~/.nebulon/
Capsules live under ~/.nebulon/capsules/. You can override the base directory
with the NEBULON_HOME environment variable.
Wallet import and export:
- Import expects keypair files in
C:\\Nebulon\\Wallets(Windows). - Export writes the active wallet to
C:\\Nebulon\\Wallets.
Version
nebulon --version
nebulon -vTroubleshooting
- If
loginor hosted actions fail, re-runnebulon configand confirm backend URLs and network settings. - If RPC calls fail, verify the configured
rpcUrlandwsUrl. - Use
nebulon contract ... --verbosefor detailed progress output.
