Ask ChatGPT plugin for Node-RED flow editor
This plugin supports generating Markdown document by ChatGPT for Node-RED flows in tab. You can use the generated document as a draft of what the flow is and how the flow is executed.
Run the following command in your Node-RED user directory - typically ~/.node-red
npm install node-red-contrib-plugin-chatgpt
Set the OpenAI key to OPENAI_API_KEY as the environment variable. In macOS or Linux environment, you can use the export command to set the environment variable.
export OPENAI_API_KEY=<API key>
The API key can be obtained from the OpenAI website. https://platform.openai.com/account/api-keys
- Create a flow and click the Deploy button.
- Double-click the tab to open the following user interface. And then, click the "Ask ChatGPT" button.
-
The ChatGPT will automatically generate the Markdown document from the deployed flow and paste it into the editor area.
-
After clicking the "Done" button, you can see the documentation in the "Information" tab.
This plugin dramatically reduce time-consuming task to write the document of the Node-RED flow.
This plugin requires Node-RED v3.1 or later to work with Mermaid diagrams.