Skip to content

Commit 5bb7bae

Browse files
committed
Update readme
1 parent 85bfb7e commit 5bb7bae

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,42 @@
1-
# Node-RED Admin
1+
# Node-RED Admin CLI
22

33
The Node-RED admin command line interface.
44

55
[![Build Status](https://travis-ci.org/node-red/node-red-admin.svg?branch=master)](https://travis-ci.org/node-red/node-red-admin) [![Coverage Status](https://coveralls.io/repos/node-red/node-red-admin/badge.svg?branch=master)](https://coveralls.io/r/node-red/node-red-admin?branch=master)
66

77

8-
A command line tool for Node-RED administrations.
8+
A command line tool for remotely administering Node-RED.
99

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

1212
npm install -g node-red-admin
1313

14-
Note: you may need to run this with `sudo`, or from within an Administrator command shell.
14+
Note: you may need to run this with `sudo`, or from within an Administrator command shell.
1515

1616
You may also need to add `--unsafe-perm` to the command if you hit permissions errors during install.
1717

18-
1918
## Usage
2019

2120
Usage:
22-
node-red-admin <command> [args] [--help]
23-
21+
node-red-admin <command> [args] [--help] [--userDir DIR] [--json]
22+
2423
Description:
2524
Node-RED command-line client
26-
25+
2726
Commands:
2827
target - Set or view the target URL and port like http://localhost:1880
2928
login - Log user in to the target of the Node-RED admin API
3029
list - List all of the installed nodes
3130
info - Display more information about the module or node
3231
enable - Enable the specified module or node set
3332
disable - Disable the specified module or node set
34-
search - Search NPM for Node-RED modules by matching name, description or keywords with the term
35-
install - Install the module from NPM
36-
remove - Remove the NPM module
37-
hash-pw - creates a hash to use for Node-RED settings like "adminAuth"
33+
search - Search for Node-RED modules to install
34+
install - Install the module from NPM to Node-RED
35+
remove - Remove the NPM module from Node-RED
36+
hash-pw - Creates a hash to use for Node-RED settings like "adminAuth"
37+
38+
By default, the tool stores its configuration in `~/.node-red/.cli-config.json`. You
39+
can specify a different directory for the config file using the `--userDir` argument.
3840

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

0 commit comments

Comments
 (0)