0.0.2 • Published 2 years ago
@bkouhen/rnd-cli v0.0.2
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @bkouhen/rnd-cli
$ rnd COMMAND
running command...
$ rnd (--version)
@bkouhen/rnd-cli/0.0.2 linux-x64 node-v16.15.1
$ rnd --help [COMMAND]
USAGE
$ rnd COMMAND
...
Commands
rnd autocomplete [SHELL]
rnd commands
rnd help [COMMAND]
rnd plugins
rnd plugins:install PLUGIN...
rnd plugins:inspect PLUGIN...
rnd plugins:install PLUGIN...
rnd plugins:link PLUGIN
rnd plugins:uninstall PLUGIN...
rnd plugins:uninstall PLUGIN...
rnd plugins:uninstall PLUGIN...
rnd plugins update
rnd script generate NAME
rnd autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ rnd autocomplete [SHELL] [-r]
ARGUMENTS
SHELL shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
display autocomplete installation instructions
EXAMPLES
$ rnd autocomplete
$ rnd autocomplete bash
$ rnd autocomplete zsh
$ rnd autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
rnd commands
list all the commands
USAGE
$ rnd commands [--json] [-h] [--hidden] [--columns <value> | -x] [--sort <value>] [--filter <value>]
[--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--hidden show hidden commands
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
list all the commands
See code: @oclif/plugin-commands
rnd help [COMMAND]
Display help for rnd.
USAGE
$ rnd 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 rnd.
See code: @oclif/plugin-help
rnd plugins
List installed plugins.
USAGE
$ rnd plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ rnd plugins
See code: @oclif/plugin-plugins
rnd plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ rnd 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
$ rnd plugins add
EXAMPLES
$ rnd plugins:install myplugin
$ rnd plugins:install https://github.com/someuser/someplugin
$ rnd plugins:install someuser/someplugin
rnd plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ rnd 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
$ rnd plugins:inspect myplugin
rnd plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ rnd 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
$ rnd plugins add
EXAMPLES
$ rnd plugins:install myplugin
$ rnd plugins:install https://github.com/someuser/someplugin
$ rnd plugins:install someuser/someplugin
rnd plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ rnd 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
$ rnd plugins:link myplugin
rnd plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ rnd plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ rnd plugins unlink
$ rnd plugins remove
rnd plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ rnd plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ rnd plugins unlink
$ rnd plugins remove
rnd plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ rnd plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ rnd plugins unlink
$ rnd plugins remove
rnd plugins update
Update installed plugins.
USAGE
$ rnd plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
rnd script generate NAME
Generate a new script
USAGE
$ rnd script generate [NAME] [-d <value>]
ARGUMENTS
NAME Name of the script folder you want to create
FLAGS
-d, --dir=<value> Path to the folder where you want to create a new script
DESCRIPTION
Generate a new script
EXAMPLES
$ rnd script generate foo
$ rnd script generate foo --dir=/home/user/