@noego/create

Scaffold a NoEgo v1 application that uses the current @noego/app, Dinner, Forge, and IoC contracts.

Requirements

• Node.js 20.11 or newer
• npm

Usage

npx @noego/create my-app

The package also installs the create-noego and noego-create binaries. Run without a project name for interactive prompts.

create-noego [project-name] [options]

| Option | Description | | --- | --- | | --template <type> | full-stack, api-only, or minimal | | --database <type> | sqlite or postgres; ignored by minimal | | --port <number> | Development port; defaults to 3000 | | --jobs / --no-jobs | Enable or disable the Captain jobs example | | --no-seeds | Do not create Proper seed directories or scripts | | --yes, -y | Accept non-interactive defaults | | --force | Replace an existing target directory | | --help, -h | Show CLI help | | --version, -v | Print the package version |

Templates

full-stack

Creates an OpenAPI backend plus a Svelte 5 frontend rendered by Forge. The browser entry imports mountFrontend from the generated noego:frontend virtual module. The project uses the strict version 1 noego.config.yml contract and builds for Node by default.

api-only

Creates the OpenAPI backend, IoC controller example, selected database configuration, migrations, and optional jobs without frontend files.

minimal

Creates the smallest NoEgo host with runtime boot hooks and no database, OpenAPI, or frontend scaffolding.

Generated project

Depending on the template, the generated project includes:

• noego.config.yml using version: 1
• src/server/server.ts with node and worker boot hooks
• an OpenAPI status route and IoC controller for non-minimal templates
• src/ui/main.ts, an HTML shell, Svelte routes, views, and layouts for full-stack
• Proper configuration and migrations for database-backed templates
• optional Captain jobs and Proper seed directories
• NOEGO_FRAMEWORK_GUIDE.md with the current runtime contracts

The generator initializes a Git repository and stages generated files when Git is available.

Start the project

For full-stack and api-only projects:

cd my-app
cp .env.example .env
npm install
npm run reset
npm run dev

For minimal projects, omit the database reset:

cd my-app
cp .env.example .env
npm install
npm run dev

Available scripts include dev, build, start, typecheck, and lint. Database-backed templates also include reset; seed-enabled templates include seed.

Build targets

The generated config defaults to Node:

npm run build

To create a Cloudflare Workers package:

npx noego build --target cloudflare --nodejs-compat

Review runtime dependencies before targeting Workers; database drivers and other Node-oriented packages may require nodejs_compat or a platform-native replacement.

Developing @noego/create

npm install
npm run build
node bin/create.js my-app --yes

npm test currently reports that this package has no automated test suite.