Skip to main content

CLI reference

create-qorechain-rollup scaffolds a complete, ready-to-run rollup starter project. Each template is built around one of the five preset profiles, plus a multivm-rollup starter for cross-VM (EVM → QoreChain Native) calls.

Published on npm as create-qorechain-rollup (run via npm create qorechain-rollup). To operate an existing rollup, see the qorollup reference.

Usage​

npm create qorechain-rollup <dir> [options]
# or
npx create-qorechain-rollup <dir> [options]

Run without --yes for an interactive picker, or pass flags to skip the prompts.

Arguments​

ArgumentDescription
<dir>Target directory for the new project

Options​

OptionDescription
-t, --template <name>Template to use (see below)
--network <name>Network preset: testnet or mainnet
--package-manager <pm>Package manager: pnpm, npm, or yarn
-y, --yesSkip prompts and use defaults
--no-installDo not install dependencies after scaffolding
--localRewrite @qorechain/* deps to local file links into the monorepo (for local/dev use before the packages are published)
-h, --helpShow help
-v, --versionPrint the version

Templates​

TemplateProfileHighlights
defi-rollupdefizk-SNARK / dedicated / native / EIP-1559 / EVM. Includes a reference SNARK prover.
gaming-rollupgamingbased / based / native / flat gas / custom VM. High throughput, low latency.
nft-rollupnftoptimistic / dedicated / QoreChain Native. Includes the challenge flow and Celestia notice.
enterprise-rollupenterprisebased / based / native / subsidized gas / EVM. Permissioned-friendly.
custom-rollupcustomFully parameterized config with every field documented and validated.
multivm-rollupcustomEVM rollup that calls QoreChain Native via the cross-VM precompile. Includes a contracts/CrossVmCaller.sol snippet (EVM → QoreChain Native).

Examples​

# DeFi starter, interactive prompts for the rest.
npm create qorechain-rollup my-rollup -- --template defi-rollup

# Gaming starter, non-interactive.
npx create-qorechain-rollup my-rollup --template gaming-rollup --yes

# NFT starter wired to local monorepo packages, no install.
npx create-qorechain-rollup my-rollup -t nft-rollup --local --no-install

Each scaffolded project includes a rollup.config.ts built from its preset, an .env.example for your network and operator key, and scripts to create the rollup, submit batches, and query status. See the Quickstart for the equivalent flow in code.