Quick start

Requires Node.js ≥ 24. After install, the bermooda binary is available globally.

Scaffold a shop

npm i -g @bermooda/cli@latest

bermooda install --local --dir ./my-shop -y \
  --admin-email [email protected] \
  --admin-password 'TestPass123!' \
  --store-name 'Demo Shop'

cd my-shop
bermooda dev

Open http://localhost:3000. Admin is at /admin.

--local uses SQLite defaults so you can boot without Docker or an external database. -y skips prompts when you pass the admin and store flags.

Configuration

Placeholder values in .env are enough to boot the app. Wire real keys when you need payments, email, OAuth, or object storage. See Configuration.

Offline install

If you already have a checkout of bermooda/bermooda, skip the network download with --source:

bermooda install --local --source /path/to/bermooda --dir ./my-shop -y \
  --admin-email [email protected] \
  --admin-password 'TestPass123!' \
  --store-name 'Demo Shop'

Next steps

• CLI commands — flags for install, plugins, themes, and updates
• Configuration — environment variables and OAuth redirects
• Local development — contributing from a git checkout of the platform