@noego/create

CLI scaffolding tool for NoEgo framework applications.

@noego/create generates a ready-to-run project with NoEgo server wiring, optional database support, optional Svelte frontend, testing helpers, linting config, and a framework guide copied into the generated app.

Usage

npx @noego/create my-app

The package exposes two equivalent binaries:

create-noego my-app
noego-create my-app

Run without a project name to use the interactive prompts:

npx @noego/create

Options

create-noego [project-name] [options]

| Option | Description | | --- | --- | | --template <type> | Template type: full-stack, api-only, or minimal. | | --database <type> | Database type: sqlite or postgres. Ignored for minimal. | | --port <number> | Development server port. Defaults to 3000. | | --jobs | Enable the Captain background jobs example. | | --no-jobs | Disable background jobs. | | --no-seeds | Disable Proper seed directories and seed scripts. | | --yes, -y | Accept defaults for non-interactive creation. | | --force | Overwrite an existing target directory without prompting. | | --help, -h | Show CLI help. | | --version, -v | Print the package version. |

Templates

full-stack

Generates an Express backend, Svelte 5 frontend, Wood/Stitch/OpenAPI wiring, SQLStack repository example, Proper database config, Vitest integration tests, and Forge UI test scaffolding.

api-only

Generates the backend, database, repository, OpenAPI, middleware, and integration-test structure without frontend files.

minimal

Generates the smallest Express server with IoC container setup and basic project config. Database, OpenAPI, frontend, and test scaffolding are omitted.

Examples

create-noego my-app
create-noego my-api --template api-only
create-noego my-app --template full-stack --database postgres
create-noego my-app --template full-stack --database sqlite --yes
create-noego worker-app --template api-only --jobs --no-seeds

Generated Project

Depending on the selected template, generated projects can include:

• src/server/server.ts, src/server/container.ts, and src/index.ts
• example status controller, service, logic, repository, and SQL files
• src/server/stitch.yaml and OpenAPI YAML files
• src/ui Svelte frontend files for full-stack
• migrations/ and proper.json for database-backed templates
• seed directories when seeds are enabled
• src/jobs/tasks.yaml and an example job when jobs are enabled
• test/ helpers and example tests for full-stack
• NOEGO_FRAMEWORK_GUIDE.md

The generator initializes a Git repository in the new project and stages the generated files when Git is available.

After Creating a Project

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

If seeds were enabled:

npm run seed

For full-stack projects, install Chromium before running the example UI tests:

npx playwright install chromium
npm run test:ui

Development

From this package directory:

npm install
npm run build

Useful scripts:

| Script | Description | | --- | --- | | npm run build | Compile TypeScript and copy static templates into dist. | | npm run dev | Run TypeScript in watch mode. | | npm test | Placeholder test script. |

To try local changes, build first and run the local binary:

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