create-node-red

🌐 English | Русский

A CLI wrapper around nrb init from node-red-builder, designed for use with npm create / bunx. Requires Bun.

Usage

npm create node-red
npm create node-red my-nodes

bunx create-node-red
bunx create-node-red my-nodes

What it creates

Calls nrb init [projectDir], which generates:

• package.json with scripts and empty node-red.nodes
• tsconfig.json for TypeScript and JSDoc type checking
• node-red-builder.config.js
• .gitignore

With --example flag, it also generates an example node:

• src/nodes/example/ — runtime.js, ui.js, template.html
• src/locales/en-US/example.json
• docs/en-US/nodes/example.md

The prefix is automatically inferred from the directory name or the root package.json name if in a monorepo. Prefixes like node-red-contrib- and node-red- are stripped.

Files that already exist are skipped.

Generated package.json

{
    "name": "node-red-contrib-<prefix>",
    "version": "1.0.0",
    "type": "module",
    "scripts": {
        "test":    "tsc -p ./tsconfig.json",
        "start":   "node-red-builder start",
        "dev":     "node-red-builder dev",
        "build":   "node-red-builder build",
        "prepack": "bun run build"
    },
    "node-red": {
        "version": ">=3.0.0",
        "nodes": { "example": "dist/nodes/example.js" }
    },
    "files": ["./dist/", "./examples/"],
    "devDependencies": {
        "@types/node-red": "^1.3.5",
        "node-red":         "^4.1.7",
        "node-red-builder": "^1.1.0",
        "typescript":       "^5.9.3"
    },
    "engines": { "node": ">=18.0.0" }
}

Next steps

cd my-nodes
npm install
npm run dev   # → http://localhost:3000

To add more nodes:

bunx nrb add my-sensor

Options

npm create node-red [projectDir]

  projectDir   Target directory (optional, defaults to cwd)

  -h, --help
  -v, --version