{"library":"node-red-admin","title":"Node-RED Admin CLI","description":"The `node-red-admin` package provides a command-line interface for remote administration of Node-RED instances. It enables users to perform various management tasks such as listing, enabling, disabling, installing, and removing Node-RED nodes, setting target Node-RED instances, authenticating users, and generating hashed passwords for `adminAuth` configuration. The current stable version is 4.1.5, with frequent patch and minor releases, and major versions typically update Node.js compatibility and introduce core changes. It can be installed globally as a standalone tool or is bundled and available when `node-red` itself is installed. Its primary differentiator is offering a robust, scriptable interface for managing Node-RED environments without needing direct access to the Node-RED editor UI, making it invaluable for automation and deployment workflows.","language":"javascript","status":"active","last_verified":"Sat Apr 25","install":{"commands":["npm install node-red-admin"],"cli":{"name":"node-red-admin","version":null}},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"/*\n  The node-red-admin tool is used via shell commands. Below are examples of how to install and use it.\n  These commands should be executed in your terminal.\n*/\n\n// Install node-red-admin globally using npm:\nconsole.log('npm install -g node-red-admin');\n\n// Get general help for the command-line tool:\nconsole.log('node-red-admin --help');\n\n// Set the target Node-RED instance (replace with your Node-RED server URL):\nconsole.log('node-red-admin target http://localhost:1880');\n\n// Log in to the target Node-RED instance (you will be prompted for credentials):\nconsole.log('node-red-admin login');\n\n// List all installed nodes on the targeted Node-RED instance:\nconsole.log('node-red-admin list');\n\n// Generate a hashed password for use in Node-RED's adminAuth settings:\nconsole.log('node-red-admin hash-pw \"your_secure_password_here\"');\n\n// Install a new Node-RED module from npm:\nconsole.log('node-red-admin install node-red-contrib-example');\n\n// List nodes and output in JSON format for scripting:\nconsole.log('node-red-admin list --json');","lang":"javascript","description":"Demonstrates global installation and common command-line usages of the Node-RED Admin CLI, including setting targets, logging in, listing nodes, and hashing passwords.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}