oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @node-flow/cli
$ nf COMMAND
running command...
$ nf (--version)
@node-flow/cli/0.0.1-alpha.11 linux-x64 node-v16.16.0
$ nf --help [COMMAND]
USAGE
$ nf COMMAND
...
Commands
nf flow [FLOWID]
Create a Flow
USAGE
$ nf flow [FLOWID] [-a]
FLAGS
-a, --all List all Flow
DESCRIPTION
Create a Flow
See code: dist/commands/flow/index.js
nf flow activate [FLOWID]
Create a Flow
USAGE
$ nf flow activate [FLOWID] [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a Flow
nf flow create
Create a Flow
USAGE
$ nf flow create [--raw <value>]
FLAGS
--raw=<value>
DESCRIPTION
Create a Flow
nf flow next [FLOWID]
Flow to the next state
USAGE
$ nf flow next [FLOWID]
DESCRIPTION
Flow to the next state
EXAMPLES
flow next
nf flow remove FLOWID
Remove a Flow
USAGE
$ nf flow remove [FLOWID] [--nodes <value>]
FLAGS
--nodes=<value>...
DESCRIPTION
Remove a Flow
nf help [COMMAND]
Display help for nf.
USAGE
$ nf help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for nf.
See code: @oclif/plugin-help
nf plugins
List installed plugins.
USAGE
$ nf plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ nf plugins
See code: @oclif/plugin-plugins
nf plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ nf plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ nf plugins add
EXAMPLES
$ nf plugins:install myplugin
$ nf plugins:install https://github.com/someuser/someplugin
$ nf plugins:install someuser/someplugin
nf plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ nf plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ nf plugins:inspect myplugin
nf plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ nf plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ nf plugins add
EXAMPLES
$ nf plugins:install myplugin
$ nf plugins:install https://github.com/someuser/someplugin
$ nf plugins:install someuser/someplugin
nf plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ nf plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ nf plugins:link myplugin
nf plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ nf plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ nf plugins unlink
$ nf plugins remove
nf plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ nf plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ nf plugins unlink
$ nf plugins remove
nf plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ nf plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ nf plugins unlink
$ nf plugins remove
nf plugins update
Update installed plugins.
USAGE
$ nf plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.