oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g pluzchat
$ pluzchat COMMAND
running command...
$ pluzchat (--version)
pluzchat/0.20.0 linux-x64 node-v18.16.0
$ pluzchat --help [COMMAND]
USAGE
$ pluzchat COMMAND
...
Commands
pluzchat BaseCommand
USAGE
$ pluzchat BaseCommand
See code: dist/commands/BaseCommand.ts
pluzchat help [COMMAND]
display help for pluzchat
USAGE
$ pluzchat help [COMMAND] [--json] [--all]
ARGUMENTS
COMMAND command to show help for
FLAGS
--all see all commands in CLI
--json Format output as json.
DESCRIPTION
display help for pluzchat
See code: @oclif/plugin-help
pluzchat plugins
List installed plugins.
USAGE
$ pluzchat plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ pluzchat plugins
See code: @oclif/plugin-plugins
pluzchat plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ pluzchat 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
$ pluzchat plugins add
EXAMPLES
$ pluzchat plugins:install myplugin
$ pluzchat plugins:install https://github.com/someuser/someplugin
$ pluzchat plugins:install someuser/someplugin
pluzchat plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ pluzchat plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ pluzchat plugins:inspect myplugin
pluzchat plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ pluzchat 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
$ pluzchat plugins add
EXAMPLES
$ pluzchat plugins:install myplugin
$ pluzchat plugins:install https://github.com/someuser/someplugin
$ pluzchat plugins:install someuser/someplugin
pluzchat plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ pluzchat 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
$ pluzchat plugins:link myplugin
pluzchat plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pluzchat plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pluzchat plugins unlink
$ pluzchat plugins remove
pluzchat plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pluzchat plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pluzchat plugins unlink
$ pluzchat plugins remove
pluzchat plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pluzchat plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pluzchat plugins unlink
$ pluzchat plugins remove
pluzchat plugins update
Update installed plugins.
USAGE
$ pluzchat plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
pluzchat start
Start Pluzchat
USAGE
$ pluzchat start [-h] [-o]
FLAGS
-h, --help Show CLI help.
-o, --open opens the UI automatically in browser
DESCRIPTION
Start Pluzchat
EXAMPLES
$ pluzchat start
$ pluzchat start -o
See code: dist/commands/start.ts