Skip to main content

​
Prerequisites

Before using Node Blueprint CLI, ensure you have the following installed on your system:
Node Blueprint requires Node.js version 18 or higher. Check your version:
node --version
If you need to install or update Node.js, download it from nodejs.org or use a version manager like nvm.
You’ll need one of the following package managers:
  • npm (comes with Node.js)
  • yarn (install with npm install -g yarn)
  • pnpm (install with npm install -g pnpm)
Node Blueprint automatically detects which package manager you use and adjusts commands accordingly.
Git is recommended for version control. Node Blueprint can automatically initialize a git repository for your project.
git --version
Download Git from git-scm.com if needed.
You can install your database later, but having it ready helps you test the generated project immediately:Alternatively, use Docker to run databases in containers (Node Blueprint can generate docker-compose files for you).

​
Installation methods

Node Blueprint CLI doesn’t require global installation. Use your preferred package manager’s create command to run it directly: 
npm create node-blueprint
The create command automatically downloads and executes the latest version of Node Blueprint CLI, so you always get the newest features without manual updates.

​
Verify installation

To verify Node Blueprint CLI works correctly, run the command and check that the interactive prompts appear: 
npm create node-blueprint
You should see output similar to: 
Creating project...

┌  Creating "my-api"
│
◆  What is the name of your project?
│  _
Press Ctrl+C to exit if you’re just testing.
If you encounter permission errors, avoid using sudo. Instead, configure npm to install global packages in your home directory by following this guide.

​
CLI options

While Node Blueprint works great in interactive mode, you can also pass options directly via command-line flags:

​
Available flags

​
--name
string
required
Project name (also creates a directory with this name)
npm create node-blueprint --name my-api
​
--framework
string
required
Framework to use: express or fastify
npm create node-blueprint --framework express
​
--database
string
required
Database type: postgres, mysql, or mongodb
npm create node-blueprint --database postgres
​
--orm
string
required
ORM to use: drizzle, prisma, or mongoose
npm create node-blueprint --orm drizzle
MongoDB projects automatically use Mongoose. For PostgreSQL and MySQL, you can choose between Drizzle and Prisma.
​
--auth
string
default:"none"
Authentication method: jwt-auth or none
npm create node-blueprint --auth jwt-auth
​
--features
array
default:"[]"
Additional features to include: docker
npm create node-blueprint --features docker
​
--git
boolean
default:"true"
Initialize git repository (use --no-git to skip)
npm create node-blueprint --no-git
​
--install
boolean
default:"true"
Install dependencies (use --no-install to skip)
npm create node-blueprint --no-install

​
Non-interactive example

Create a complete project without any prompts: 
npm create node-blueprint \
  --name my-api \
  --framework express \
  --database postgres \
  --orm drizzle \
  --auth jwt-auth \
  --features docker
When using command-line flags, all required options (--name, --framework, --database, --orm) must be provided, or the CLI will show an error.

​
Troubleshooting

If you see command not found: create-node-blueprint, ensure:
  1. You’re using the correct syntax: npm create node-blueprint (not npm install)
  2. Your npm version is up to date: npm install -g npm@latest
  3. Your internet connection is active (the package downloads on demand)
Avoid using sudo with npm. Instead:
  1. Configure npm to use a directory in your home folder
  2. Follow npm’s official guide
  3. Or use a Node version manager like nvm
Node Blueprint auto-detects your package manager from the environment. If it selects the wrong one:
  1. The CLI uses whichever create command you ran (npm, yarn, or pnpm)
  2. You can manually edit package.json scripts after generation
  3. Delete node_modules and run your preferred package manager’s install command
If you encounter module resolution errors:
  1. Ensure your Node.js version is 18 or higher
  2. Check that package.json includes "type": "module"
  3. Verify tsconfig.json has "module": "ESNext" and "moduleResolution": "node"

​
Next steps

Quickstart guide

Now that Node Blueprint CLI is installed, create your first project and learn the generated project structure.

Build docs developers (and LLMs) love

Get started for freeTalk to us