Skip to main content
The Crave CLI (craveup) bootstraps a production-ready storefront in a few minutes. It installs dependencies, wires environment variables, and can even start the dev server for you.

​
Install & run

Run the CLI anywhere you want to create the project directory: 
npx craveup init
The wizard will guide you through:
  • Choosing a template (default, Tomodashi Sushi, Xichuan Noodles, or a custom Git repo)
  • Authorizing with the Crave dashboard to obtain an API key
  • Naming the project directory
  • Installing dependencies with your detected package manager
  • Optionally starting pnpm dev so you can preview immediately

​
Non-interactive usage

Prefer automation or CI pipelines? Use flags to skip prompts.
FlagDescription
--template <id>Force a template (default, tomodashi-sushi, xichuan-noodles, or a Git URL)
--dir <name>Set the target directory name
--api-key <key>Provide the API key up front
--skip-installScaffold files without running the package manager
--forceOverwrite an empty directory without confirmation
Example: 
npx craveup init \
  --template default \
  --dir crave-storefront \
  --api-key sk_live_123 \
  --skip-install

​
Environment variables

The CLI creates .env.local with placeholders. Update them before running the app: 
NEXT_PUBLIC_API_URL=https://api.craveup.com/api/v1
NEXT_PUBLIC_API_KEY=sk_live_xxx
NEXT_PUBLIC_LOCATION_ID=loc_abc123
Tip: keep separate API keys per environment. The CLI respects CRAVEUP_DASHBOARD_URL and CRAVEUP_PARTNER_API_URL if you need to point at staging.

​
Project anatomy

Every template ships with:
  • Next.js 15 + App Router for modern server-first rendering
  • @craveup/storefront-sdk preconfigured in src/lib/storefront-client.ts
  • Typed API helpers co-located with app routes
  • Component library for menu browsing, cart management, and checkout
Explore the generated repository after the CLI finishes: 
cd crave-storefront
pnpm install # if you skipped installation
pnpm dev --port 3000
You now have a fully functional storefront backed by live Crave data. Continue to the Storefront SDK guide to integrate custom flows.
⌘I