The node-red-admin command-line tool allows you to remotely administer a Node-RED instance.
Since Node-RED 1.1.0,
node-red-admin is now built into the
node-red command -
you do not need to install it separately.
To use the version included with
node-red, use the command
If you install it separately, you would use the command
If you want to install
node-red-admin separately, you can install it as a global
npm install -g --unsafe-perm node-red-admin
sudois required if running as a non-root user on Linux/OS X. If running on Windows, you will need to run in a command shell as Administrator, without the
To remotely administer a Node-RED instance, the tool must first be pointed at the Node-RED instance you want
it to access. By default, it assumes
http://localhost:1880. To change that, use the
node-red-admin target http://node-red.example.com/admin
If authentication is enabled, you must then
These commands create a file called
~/.node-red/.cli-config.json that stores
the target and access token information.
The tool provides the following commands:
target- Set or view the target URL and port like http://localhost:1880
login- Log user in to the target of the Node-RED admin API
list- List all of the installed nodes
info- Display more information about the module or node
enable- Enable the specified module or node set
disable- Disable the specified module or node set
search- Search for Node-RED modules to install
install- Install the module from NPM to Node-RED
remove- Remove the NPM module from Node-RED
hash-pw- Create a password hash that can be used with the
Node-RED: Low-code programming for event-driven applications.
Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.