Multitenant

multitenant init

Scaffold `tenants.config.json` and starter files.

Writes a minimal, valid tenants.config.json and optionally starter files for an adapter.

Usage

npx @multitenant/cli init [options]

Common options

OptionDefaultDescription
--cwdprocess.cwd()Working directory
--tenantmainTenant id
--marketdefaultMarket id
--local-hostmain.localhostHost for domains.local
--frameworknonenone | next-app | next-pages | express
--forceoffNon-interactive overwrite

What gets created

  1. Validates before write (same as multitenant check).
  2. If tenants.config.json exists, prompts unless --force (or errors if non-TTY without --force).

--framework

ValueFiles
noneConfig only
next-appmiddleware.ts using createTenantMiddleware
next-pageslib/tenant-registry.ts for GSSP / API wrappers
expressmultitenant.server.example.ts — rename into your server

Install peers: @multitenant/next-app, next, react, etc., as needed.

After init

npx @multitenant/cli check

For multi-host local dev, use npx @multitenant/cli dev (or multitenant dev after npm install @multitenant/cli) — dev, check, print.

On this page