Shape
Docs

Local development

Run the desktop app locally and point it at Cloud.

Prerequisites

  • Node.js 18+
  • Rust (stable), with targets required by Tauri 2

Install and run

Shell
npm install
npm run tauri:dev

Which Cloud URL does the IDE use?

ModeCloud URL
npm run tauri:devNEXT_PUBLIC_SHAPE_WEBSITE_URL from .env, else http://localhost:3000
npm run tauri:build / GitHub releaseAlways https://www.useshape.org (.env ignored)

Copy .env.example.env to change the dev target.

The website that hosts Shape Cloud is a separate product. You only need its public URL — not the website source — to develop the desktop app.

Useful scripts

ScriptPurpose
npm run tauri:devDesktop development
npm run tauri:buildProduction Tauri build
npm run testVitest
npm run test:rustCargo tests
npm run test:allFrontend and Rust tests
npm run docs:indexRebuild the docs search index

Cloud AI while developing

Official release builds can use Shape Cloud AI. Local and fork builds can still run the IDE; Cloud AI may return error 3000 until you use an official installer from download.

Edit