CyberFlow

Command-line Administration

The CyberFlow-admin command-line tool allows you to remotely administer a CyberFlow instance.

Since CyberFlow 1.1.0, CyberFlow-admin is now built into the CyberFlow command - you do not need to install it separately.

To use the version included with CyberFlow, use the command CyberFlow admin.

If you install it separately, you would use the command CyberFlow-admin.

Installation

If you want to install CyberFlow-admin separately, you can install it as a global module with:

npm install -g --unsafe-perm CyberFlow-admin
Note : sudo is 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 sudo command.

Target and Login

To remotely administer a CyberFlow instance, the tool must first be pointed at the CyberFlow instance you want it to access. By default, it assumes http://localhost:1880. To change that, use the target command:

CyberFlow-admin target http://CyberFlow.example.com/admin

If authentication is enabled, you must then login:

CyberFlow-admin login

These commands create a file called ~/.cyberflow/.cli-config.json that stores the target and access token information.

Note : The `hash-pw` option does not require the tool to be logged in and can be run at any time.

Other commands

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 CyberFlow 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 CyberFlow modules to install
  • install - Install the module from NPM to CyberFlow
  • remove - Remove the NPM module from CyberFlow
  • hash-pw - Create a password hash that can be used with the adminAuth and httpNodeAuth settings

Video walkthrough placeholder

Add an embedded walkthrough for this section by inserting an <iframe> or <video> element and applying the is-visible class to this container.

Example: <div class="video-placeholder is-visible">...</div>