Skip to content

weld create

The recommended way to create a new WELD app:

Terminal window
npm create weld-app
npm create weld-app my-app

Or using the CLI directly:

Terminal window
npx @weldjs/cli create my-app
npx @weldjs/cli create my-app --template fullstack
npx @weldjs/cli create my-app --template minimal
Template Includes
spa (default) React + Vite + Router + Forms + API client
fullstack Everything in SPA + @weldjs/server backend
minimal React + Vite + basic shell only
my-app/
src/
main.tsx — WeldProvider + React root
App.tsx — Shell + Router
pages/
Home.tsx — Starter page
lib/
api.ts — Weld client
index.html
vite.config.ts
tsconfig.json
.env
package.json

After scaffolding:

Terminal window
cd my-app
npm install
npm run dev