Skip to main content

​
Option Reference

All options for the create-node-blueprint CLI tool, with detailed descriptions, valid values, and usage examples.

​
Required Options

These options are required when using non-interactive mode. If any are omitted, the CLI will enter interactive mode.

​
--name / -n

​
name
string
required
The name of your project. This will be used as the directory name and package name.Validation: Must contain only lowercase letters, numbers, and hyphens (matching pattern: /^[a-z0-9-]+$/)Default: "" (empty string triggers interactive mode)
Examples: 
# Valid names
create-node-blueprint --name my-api
create-node-blueprint --name blog-backend-2024
create-node-blueprint -n user-service

# Invalid names (will fail validation)
create-node-blueprint --name MyAPI          # uppercase not allowed
create-node-blueprint --name my_api         # underscores not allowed
create-node-blueprint --name "my api"       # spaces not allowed

​
--framework / -f

​
framework
string
required
The Node.js web framework to use for your project.Valid values:
  • express - Express.js framework
  • fastify - Fastify framework
Default: "" (empty string triggers interactive mode)
Examples: 
create-node-blueprint --framework express
create-node-blueprint -f fastify

​
--database / -d

​
database
string
required
The database system to configure for your project.Valid values:
  • mysql - MySQL database
  • postgres - PostgreSQL database
  • mongodb - MongoDB database
Default: "" (empty string triggers interactive mode)
Your database choice affects which ORMs are available. MongoDB requires the mongoose ORM.
Examples: 
create-node-blueprint --database postgres
create-node-blueprint -d mongodb

​
--orm / -o

​
orm
string
required
The ORM (Object-Relational Mapping) or ODM (Object-Document Mapping) tool to use.Valid values:
  • prisma - Prisma ORM (MySQL, PostgreSQL)
  • drizzle - Drizzle ORM (MySQL, PostgreSQL)
  • mongoose - Mongoose ODM (MongoDB only)
Default: "" (empty string triggers interactive mode)
When using --database mongodb, you must use --orm mongoose. Prisma and Drizzle are only compatible with SQL databases (MySQL, PostgreSQL).
Examples: 
# For SQL databases
create-node-blueprint --orm prisma
create-node-blueprint -o drizzle

# For MongoDB
create-node-blueprint --database mongodb --orm mongoose

​
Optional Options

These options have default values and can be omitted.

​
--auth / -a

​
auth
string
default:"none"
Authentication method to include in your project setup.Valid values:
  • jwt-auth - Basic JWT (JSON Web Token) authentication with login/register endpoints
  • none - No authentication setup
Default: none
Examples: 
# Include JWT authentication
create-node-blueprint --auth jwt-auth

# Explicitly specify no authentication
create-node-blueprint --auth none

# Omit for default (no auth)
create-node-blueprint

​
--features

​
features
array
default:"[]"
Additional features to include in your project. This option accepts multiple values.Valid values:
  • docker - Include Docker setup with Dockerfile and docker-compose.yml
Default: [] (empty array)
Examples: 
# Add Docker support
create-node-blueprint --features docker

# Future: Multiple features (when more are available)
create-node-blueprint --features docker --features other-feature

​
--git

​
git
boolean
default:"true"
Whether to initialize a git repository in the project directory.Default: trueWhen enabled, the CLI will:
  • Run git init in the project directory
  • Create an initial commit with the generated project files
Examples: 
# Initialize git (default behavior)
create-node-blueprint --git

# Skip git initialization
create-node-blueprint --no-git

​
--install

​
install
boolean
default:"true"
Whether to automatically install npm dependencies after project creation.Default: trueWhen enabled, the CLI will run npm install in the project directory after scaffolding files.
Examples: 
# Install dependencies (default behavior)
create-node-blueprint --install

# Skip dependency installation
create-node-blueprint --no-install
If you use --no-install, you’ll need to manually run npm install in your project directory before running the application.

​
Option Combinations

​
Minimal Required Options

create-node-blueprint -n my-app -f express -d postgres -o prisma

​
All Options Specified

create-node-blueprint \
  --name my-complete-app \
  --framework express \
  --database postgres \
  --orm drizzle \
  --auth jwt-auth \
  --features docker \
  --git \
  --install

​
Quick Setup for Development

# Skip git and installation for faster iteration
create-node-blueprint \
  -n dev-project \
  -f express \
  -d postgres \
  -o prisma \
  --no-git \
  --no-install

​
MongoDB Project

create-node-blueprint \
  --name mongo-app \
  --framework express \
  --database mongodb \
  --orm mongoose \
  --auth jwt-auth

​
Boolean Option Syntax

Boolean options support two syntaxes: 
# Enable (explicitly)
--git
--install

# Disable
--no-git
--no-install
For boolean options with true as the default, you typically only need to use the --no-* form to disable them.

​
Validation Rules

​
Project Name

  • Pattern: /^[a-z0-9-]+$/
  • Allowed: lowercase letters, numbers, hyphens
  • Not allowed: uppercase letters, underscores, spaces, special characters

​
Database/ORM Compatibility

DatabaseCompatible ORMs
postgresprisma, drizzle
mysqlprisma, drizzle
mongodbmongoose (only)

​
Environment Considerations

All options can be provided via command-line arguments. The CLI does not currently read from environment variables or configuration files.

Build docs developers (and LLMs) love

Get started for freeTalk to us