@multitenant/cli
v0.5.4
Published
CLI for working with `@multitenant/*` multi-tenant packages. It exposes a `multitenant` binary (with a deprecated `tenantify` alias) with:
Readme
@multitenant/cli
CLI for working with @multitenant/* multi-tenant packages. It exposes a multitenant binary (with a deprecated tenantify alias) with:
multitenant init– scaffoldtenants.config.jsonand optional framework stubs (Next App Router, Next Pages registry, Express example)multitenant check– validatetenants.config.jsonmultitenant print– print tenants/markets summarymultitenant dev– start a local dev proxy with per-tenant subdomains
Testing (this repo / contributors)
npm test -w @multitenant/cli
npm run test:coverage -w @multitenant/cliInstall
The npm package is @multitenant/cli (binary multitenant). npx multitenant … fails with 404 — use npx @multitenant/cli … or install first.
npm install -D @multitenant/cliAdd a script:
{
"scripts": {
"tenant:dev": "multitenant dev --target http://localhost:3000 --port 3100"
}
}Commands
multitenant init
npx @multitenant/cli init [--framework next-app|next-pages|express|none] [--force]Writes a minimal valid tenants.config.json at --cwd (default: current directory). Full reference: docs/CLI/init.md.
multitenant check
npx @multitenant/cli checkValidates tenants.config.json in the current working directory and prints any schema or cross-field errors.
multitenant dev
npx @multitenant/cli dev --target http://localhost:3000 --port 3100- Spins up a proxy on
--port - Resolves tenant by
Hostheader using yourtenants.config.json - Forwards traffic to
--target
Optional:
--run-dev– automatically runnpm|pnpm|yarn run devin your app before starting the proxy.
Open source
MIT licensed — github.com/klypalskyi/multitenant · Issues · npm
