@notty/create

Project scaffolder for Notty CMS.

Public contract: use the create-notty binary. The package does not expose a supported module API.

Usage

Community projects can install from the public @notty scope:

npx @notty/create my-project
npx @notty/create my-project --edition community
npx @notty/create my-plugin --plugin
npx @notty/create my-theme --theme

Paid editions require access to the private Notty package registry:

npx @notty/create my-project --edition business

Or with npm:

npm create @notty my-project

If you do not have paid registry access, use Community or install from an edition-specific portable distribution.

Options

Supported flows:

• Project name
• Database type (SQLite, PostgreSQL, MySQL)
• --edition <community|pro|business|enterprise> to install the matching @notty/edition-* package
• --notty-version <version> to pin the generated runtime and SDK line for @notty/server, @notty/core, @notty/plugin-api, @notty/theme-api, and engines.notty
• --offline to skip npm registry checks and use local monorepo versions for development-only scaffolds
• --plugin for plugin scaffolding
• --theme for theme scaffolding
• Package manager selection

Version Resolution

@notty/create queries the npm registry before scaffolding so generated projects do not silently depend on unpublished local monorepo versions. For project scaffolds it checks only the packages required by the selected edition. Community scaffolds do not require access to Pro, Business, or Enterprise packages.

If the registry is unreachable or the selected paid package is restricted, the CLI fails before writing files and prints recovery steps:

npx @notty/create my-project --notty-version 1.0.2

For local monorepo development, use:

pnpm --filter @notty/create dev -- my-project --offline

Offline mode does not run dependency install. Configure a private registry or link local @notty/* packages before installing dependencies.

Generated app scaffold:

• registers src/plugins/app.ts in notty.config.ts as an explicit app-local runtime registration
• wires src/routes, src/services, src/policies, src/hooks, and src/middlewares through that app-local plugin
• keeps src/controllers as user-owned support modules imported by route/service code

License

MIT

Part of Notty CMS