ParaSpell

Appearance

Getting started with ParaSpell CLI ⌨️ ​

ParaSpell CLI scaffolds ready-to-run starter apps for XCM SDK and XCM API. A short wizard that creates the project and installs its dependencies for you based on your choices.

INFO

Prerequisites: ​

  • Node.js 24 or newer

Quick start ​

Choose your package manager:

pnpm dlx paraspell-cli@latest

Interactive mode ​

  1. Choose XCM SDK or XCM API.
  2. Choose React, Vue, or Node.js.
  3. Pick a Polkadot client for the SDK: PAPI (recommended), Polkadot.js, or Dedot.
  4. Choose the Swap, EVM, and Snowbridge extensions.
  5. Name the project and choose a package manager.
  6. Optionally configure a development wallet for Node.js.
  7. Review the configuration before files are written.

INFO

Project creation and dependency installation report live progress. If installation fails, the generated project is kept and the CLI prints the command to finish it manually.

What to choose 🧰 ​

ChoiceOptionsPick based on
ToolXCM SDK / XCM APIXCM SDK calls ParaSpell directly from your app. XCM API builds transfers via REST while you sign them locally, keeping XCM logic out of your app.
ExtensionsEVM, Swap, SnowbridgeEVM for EVM-chain origins, Swap for cross-chain swaps (@paraspell/swap), Snowbridge for Ethereum ↔ Polkadot transfers.
Wallet secrets (Node.js only)Configure / skipConfigure a development wallet (e.g. //Alice) so the generated server can sign and submit live transfers on POST /; skip it to wire up signing yourself. Secrets are entered via masked prompts and written to a gitignored .env.

WARNING

Avoid typing secrets literally when passing them as flags in shared shells or CI logs: command-line values can be saved in shell history. Prefer the interactive prompt, or edit .env directly.

Getting help ​

pnpm dlx paraspell-cli@latest --help
pnpm dlx paraspell-cli@latest sdk --help
pnpm dlx paraspell-cli@latest api --help

INFO

These commands run the CLI once without installing it, so paraspell-cli alone won't work afterward. Install it globally (npm i -g paraspell-cli) to call paraspell-cli --help directly.

Want to skip the prompts and generate a project in one command? See command mode.