# nodered-node-incubator > Node-RED node project incubator Latest version **0.1.1** (published 2023-08-14) · ISC license · 0 weekly downloads ## Install ```sh npm install nodered-node-incubator pnpm add nodered-node-incubator yarn add nodered-node-incubator bun add nodered-node-incubator ``` Provides the command `node-inq`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.1 | | Published | 2023-08-14 | | First published | 2023-02-23 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 83.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Doth-J | | Maintainers | doth-j | | Keywords | node-red, project, incubator, typescript | ## Links - npm: https://www.npmjs.com/package/nodered-node-incubator - Repository: https://github.com/Doth-J/nodered-node-incubator - Homepage: https://github.com/Doth-J/nodered-node-incubator#readme - Issues: https://github.com/Doth-J/nodered-node-incubator/issues - npm.io page: https://npm.io/package/nodered-node-incubator ## Dependencies (2) - [prompts](https://npm.io/package/prompts.md) ^2.4.2 - [commander](https://npm.io/package/commander.md) ^10.0.0 ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 0.1.1 (latest) — 2023-08-14 - 0.1.0 — 2023-08-01 - 0.0.9 — 2023-07-31 - 0.0.8 — 2023-07-28 - 0.0.7 — 2023-07-28 - 0.0.6-ts — 2023-03-02 - 0.0.6 — 2023-03-02 - 0.0.5-ts — 2023-03-02 - 0.0.5-t — 2023-03-02 - 0.0.4-t — 2023-03-02 - 0.0.4 — 2023-02-23 - 0.0.3 — 2023-02-23 - 0.0.2 — 2023-02-23 - 0.0.1 — 2023-02-23 ## README # Node-RED Project Incubator :egg:
This is a CLI tool for generating Node-RED node projects.
## Install :zap: To install the CLI tool, execute the following command: ```console npm install -g nodered-node-incubator ``` ## Usage :rocket: Once installed, you can use the tool with by executing the `node-inq` command: ```console node-inq --help Usage: node-inq [options] [command] Nodes Project Incubator for Node-RED 🍼📦 Options: -V, --version output the version number -h, --help display help for command Commands: generate [options] Node-RED project generation tool nodes Node-RED incubated nodes tool help [command] display help for command ``` ## Generating Projects :package: To generate a new Node-RED project execute the following commmand: ```console node-inq generate --help Usage: node-inq generate [options] Generate Node-RED node project template 🥚 Options: -i,--interactive Enable interactive mode (default: false) -p, --project Project directory -l, --license Project license (default: "MIT") -ts, --typescript Generate typescript project (default: false) -e, --example Import example node (default: false) -h, --help display help for command ``` ### Interactive :baby_chick: It is highly recommened to use `interactive mode` to help you in the project generation process. Following is an example running the command: ```console node-inq generate --interactive √ Enter project directory: ... node-red-contrib-example-project √ Enter project author: ... Doth-J √ Enter project description: ... Node-RED node generation example √ Enter project license: ... ISC √ Generate Typescript project: ... yes √ Import template node: ... yes 🥚 Generating Node-RED project: - Directory: /home/doth/node-red-contrib-example-project ✔️ - Language set to "Typescript" ✔️ - Created nodes directory! ✔️ - Created "package.json"! ✔️ - Imported example node! 🐣 📕 Node-RED Incubator setup: - Installed required modules! ✔️ - Created incubator server ✔️ 📘 Typescript setup: - Installed required ts modules! ✔️ - Created "tsconfig.json"! ✔️ ✅ All done, project generated! 🖖 Let the Flow be with you ``` ### Command Line :scroll: To use the command line tool, you only need to define the `project` option with the directory of the project as shown below: ```console node-inq generate --project ./example-project 🥚 Generating Node-RED node project: - Directory: /home/doth/example-project ✔️ - Language set to "Javascript" ✔️ - Created nodes directory! ✔️ - Created "package.json"! ✔️ 📕 Node-RED Incubator setup: - Installed required modules! ✔️ - Created incubator server ✔️ ✅ All done, project generated! 🖖 Let the Flow be with you ``` ## Importing Incubated Nodes :hatching_chick: To import incubated nodes, execute the following command: ```console node-inq nodes √ Enter project directory: ... example-project √ Available nodes list: » Multi-out, Template, Topic 🐣 Importing incubated Node-RED node(s): - Imported multi-out node! 🐥 - Imported example node! 🐥 - Imported topic node! 🐥 ``` ## Incubator Server :baby_bottle: The tool creates an `incubator` folder containing a minimal Node-RED setup to get you started. Execute the following command to spin up your incubator server and fast track the development of your nodes: ```console npm run dev ``` Change the `setting.js` file accordingly to your project needs. ### Have fun developing your nodes! :star: --- _Source: https://npm.io/package/nodered-node-incubator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._