|
1 | | -# Node-RED Admin |
| 1 | +# Node-RED Admin CLI |
2 | 2 |
|
3 | 3 | The Node-RED admin command line interface. |
4 | 4 |
|
5 | 5 | [](https://travis-ci.org/node-red/node-red-admin) [](https://coveralls.io/r/node-red/node-red-admin?branch=master) |
6 | 6 |
|
7 | 7 |
|
8 | | -A command line tool for Node-RED administrations. |
| 8 | +A command line tool for remotely administering Node-RED. |
9 | 9 |
|
10 | 10 | Install this globally to make the `node-red-admin` command available on your path: |
11 | 11 |
|
12 | 12 | npm install -g node-red-admin |
13 | 13 |
|
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. |
15 | 15 |
|
16 | 16 | You may also need to add `--unsafe-perm` to the command if you hit permissions errors during install. |
17 | 17 |
|
18 | | - |
19 | 18 | ## Usage |
20 | 19 |
|
21 | 20 | Usage: |
22 | | - node-red-admin <command> [args] [--help] |
23 | | - |
| 21 | + node-red-admin <command> [args] [--help] [--userDir DIR] [--json] |
| 22 | + |
24 | 23 | Description: |
25 | 24 | Node-RED command-line client |
26 | | - |
| 25 | + |
27 | 26 | Commands: |
28 | 27 | target - Set or view the target URL and port like http://localhost:1880 |
29 | 28 | login - Log user in to the target of the Node-RED admin API |
30 | 29 | list - List all of the installed nodes |
31 | 30 | info - Display more information about the module or node |
32 | 31 | enable - Enable the specified module or node set |
33 | 32 | 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. |
38 | 40 |
|
| 41 | +The `--json` option causes the tool to format its output as JSON making it suitable |
| 42 | +for scripting. |
0 commit comments