JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 43567
  • Score
    100M100P100Q192464F
  • License Apache-2.0

The Node-RED admin command line interface

Package Exports

  • node-red-admin
  • node-red-admin/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-red-admin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Node-RED Admin CLI

The Node-RED admin command line interface.

Tests Coverage Status

A command line tool for remotely administering Node-RED.

It is built into node-red and can be run as:

node-red admin ....

Standalone install

Install this globally to make the node-red-admin command available on your path:

npm install -g node-red-admin

Note: you may need to run this with sudo, or from within an Administrator command shell.

You may also need to add --unsafe-perm to the command if you hit permissions errors during installation.

Usage

Usage:
   node-red-admin <command> [args] [--help] [--userDir DIR] [--json]

Description:
   Node-RED command-line client

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 - Creates a hash to use for Node-RED settings like "adminAuth"

By default, the tool stores its configuration in ~/.node-red/.cli-config.json. You can specify a different directory for the config file using the --userDir argument.

The --json option causes the tool to format its output as JSON making it suitable for scripting.