create-mantlejs

Project initializer for Mantle JS — scaffold a new Mantle application with a single npm create command.

Installation

No installation needed. Run directly with your package manager:

npm create mantlejs@latest my-app
# or
npx create-mantlejs my-app

Concepts

npm create convention

create-mantlejs follows the npm initializer convention. Running npm create mantlejs my-app resolves to create-mantlejs on the npm registry and invokes the create-mantlejs bin. This means users never need to install the package globally.

create-mantlejs is a thin wrapper around @mantlejs/cli's newProject() — see that package's README for the full scaffold surface (database/auth/CORS/Redis options, what gets generated).

Quick start

# Scaffold a new project (interactive prompts)
npm create mantlejs@latest my-app

# Scaffold non-interactively (flags go after `--`)
npm create mantlejs@latest my-app -- --database pg --auth local --package-manager npm

# Move into the project
cd my-app

# Install dependencies
npm install

# Start the dev server
npm run dev

API

newProject(name, options)

Re-exported from @mantlejs/cli; the bin's programmatic entry point. Returns a Promise<void> that resolves once the project has been scaffolded (and installed, unless skipInstall is set).

import { newProject } from "create-mantlejs";

await newProject("my-app", {
  database: "pg",
  auth: "local",
  packageManager: "npm",
});

CLI flags

| Flag | Values | Default | Description | |---|---|---|---| | --database <db> | pg, sqlite, mongodb, none | prompted | Database adapter | | --auth <auth> | local, google, github, facebook, apple, microsoft, linkedin, none | prompted | Auth strategy | | --cors | — | false | Enable CORS on the transport | | --redis | — | false | Wire @mantlejs/auth-redis state/refresh-token stores | | --package-manager <pm> | npm, yarn, pnpm | prompted | Package manager | | --skip-install | — | false | Skip running install after scaffold |

Types

import type { NewProjectOptions, Database, Auth, PackageManager, Transport } from "create-mantlejs";

| Type | Description | |---|---| | NewProjectOptions | Options accepted by newProject() | | Database | "pg" \| "sqlite" \| "mongodb" \| "none" | | Auth | "local" \| "google" \| "github" \| "facebook" \| "apple" \| "microsoft" \| "linkedin" \| "none" | | PackageManager | "npm" \| "yarn" \| "pnpm" | | Transport | "express" |

Development

npx nx build create-mantlejs   # compile
npx nx test create-mantlejs    # run tests
npx nx lint create-mantlejs    # lint
npx nx run create-mantlejs:e2e-scaffold   # full scaffold → build → test → boot → CRUD → SIGTERM smoke test

Publishing

Build before publishing:

npx nx build create-mantlejs

First publish:

cd packages/create-mantlejs
npm publish --access public

Subsequent releases — bump version in packages/create-mantlejs/package.json, then:

cd packages/create-mantlejs
npm publish

Testing locally with Verdaccio

# Terminal 1 — start the local registry
npx nx run @mantle/source:local-registry

# Terminal 2 — publish to it
cd packages/create-mantlejs
npm publish --registry http://localhost:4873

# Test the initializer
npm create mantlejs my-test-app --registry http://localhost:4873