Skip to main content

​
Overview

The create-node-blueprint CLI tool provides a streamlined way to scaffold Node.js projects with your preferred framework, database, and ORM configuration.

​
Basic Usage

npx create-node-blueprint [options]
When run without options, the CLI enters interactive mode where you’ll be prompted for all configuration choices.

​
Command Structure

create-node-blueprint --name <project-name> --framework <framework> --database <database> --orm <orm> [options]

​
Required Arguments

When using non-interactive mode, the following arguments are required:
​
name
string
required
Project name for your new Node.js application. Must contain only lowercase letters, numbers, and hyphens.Alias: -n
create-node-blueprint --name my-api
​
framework
string
required
Node.js framework to use for your project.Alias: -fValid values: express, fastify
create-node-blueprint --framework express
​
database
string
required
Database type for your application.Alias: -dValid values: mysql, postgres, mongodb
create-node-blueprint --database postgres
​
orm
string
required
ORM/ODM to use with your database.Alias: -oValid values: prisma, drizzle, mongoose
When using MongoDB, only mongoose is available as the ORM option.
create-node-blueprint --orm prisma

​
Optional Arguments

​
auth
string
default:"none"
Authentication method to include in your project.Alias: -aValid values: jwt-auth, noneDefault: none
create-node-blueprint --auth jwt-auth
​
features
array
default:"[]"
Additional features to include in your project. Can be specified multiple times.Valid values: dockerDefault: [] (empty array)
create-node-blueprint --features docker
​
git
boolean
default:"true"
Initialize a git repository in the project directory.Default: trueUse --no-git to skip git initialization:
create-node-blueprint --no-git
​
install
boolean
default:"true"
Install npm packages after project creation.Default: trueUse --no-install to skip dependency installation:
create-node-blueprint --no-install

​
Complete Examples

​
Basic Project with Express and PostgreSQL

create-node-blueprint \
  --name my-api \
  --framework express \
  --database postgres \
  --orm prisma

create-node-blueprint \
  --name advanced-api \
  --framework express \
  --database postgres \
  --orm drizzle \
  --auth jwt-auth \
  --features docker

​
Quick Setup Without Git or Installation

create-node-blueprint \
  --name quick-project \
  --framework express \
  --database mongodb \
  --orm mongoose \
  --no-git \
  --no-install

​
Using Short Aliases

create-node-blueprint \
  -n my-project \
  -f express \
  -d mysql \
  -o prisma \
  -a jwt-auth

​
Interactive Mode

If you omit any required arguments or run the command without options, the CLI will enter interactive mode: 
npx create-node-blueprint
See the Interactive Mode documentation for details on the interactive prompts.

​
Exit Codes

  • 0 - Success
  • 1 - Error during project creation or prompt cancellation

Build docs developers (and LLMs) love

Get started for freeTalk to us