You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 4449192
Browse filesBrowse the repository at this point in the historyBrowse files
| Tool | XCM SDK / XCM API | XCM 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. |
70
+
| Extensions | EVM, Swap, Snowbridge |**EVM** for EVM-chain origins, **Swap** for cross-chain swaps (`@paraspell/swap`), **Snowbridge** for Ethereum ↔ Polkadot transfers. |
71
+
| Wallet secrets (Node.js only) | Configure / skip | Configure 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`. |
62
72
63
-
### XCM API
73
+
> [!WARNING]
74
+
> Avoid typing secrets literally when passing them as flags in shared shells
75
+
> or CI logs: command-line values can be saved in shell history. Prefer the
76
+
> interactive prompt, or edit `.env` directly.
64
77
65
-
A REST API that builds XCM transfers while you sign them locally, so XCM
66
-
logic stays out of your app. Generate a React, Vue, or Node.js project that
67
-
calls it.
78
+
### Getting help
68
79
69
-
### Extensions
80
+
```bash
81
+
npx paraspell-cli@latest --help
82
+
npx paraspell-cli@latest sdk --help
83
+
npx paraspell-cli@latest api --help
84
+
```
70
85
71
-
Every generated app ships with a transfer flow already wired up. Add any of
72
-
these when you need them:
86
+
> [!NOTE]
87
+
> These commands run the CLI once without installing it, so `paraspell-cli`
88
+
> alone won't work afterward. Install it globally with `npm i -g
89
+
> paraspell-cli` to call `paraspell-cli --help` directly.
73
90
74
-
-**EVM** — use EVM chains as origins
75
-
-**Swap** — cross-chain swaps via `@paraspell/swap`
76
-
-**Snowbridge** — transfers between Ethereum and Polkadot
91
+
Want to skip the prompts and generate a project in one command? See
92
+
[Commands](#commands) below.
77
93
78
-
React and Vue projects generate a Vite app with wallet integration. Node.js
79
-
projects generate a headless Express server with an optional development
80
-
wallet.
94
+
### Commands
81
95
82
-
### The wizard
96
+
Every wizard step is also available as a flag. Pass everything a command
97
+
needs and the wizard is skipped entirely, or leave a value out and the CLI
98
+
only prompts for that one — handy for templates, CI pipelines, or repeated
99
+
scaffolding.
83
100
84
-
1. Choose XCM SDK or XCM API.
85
-
2. Choose React, Vue, or Node.js.
86
-
3. Pick a Polkadot client for the SDK.
87
-
4. Choose the Swap, EVM, and Snowbridge extensions.
88
-
5. Name the project and choose a package manager.
89
-
6. Optionally configure a development wallet for Node.js.
90
-
7. Review the configuration before files are written.
101
+
```bash
102
+
paraspell-cli sdk [framework] [flags]
103
+
paraspell-cli api [framework] [flags]
104
+
```
91
105
92
-
Project creation and dependency installation report live progress. If
93
-
installation fails, the generated project is kept and the CLI prints the
94
-
command to finish manually.
106
+
`framework` can also be passed positionally instead of via `--framework`.
0 commit comments