@minglabs-sz/cli
v0.0.1
Published
MingLabs CLI Tool
Downloads
3
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g mingcli
$ mingcli COMMAND
running command...
$ mingcli (--version)
mingcli/0.0.0 darwin-x64 node-v14.17.6
$ mingcli --help [COMMAND]
USAGE
$ mingcli COMMAND
...
Commands
mingcli help [COMMAND]
mingcli plugins
mingcli plugins:inspect PLUGIN...
mingcli plugins:install PLUGIN...
mingcli plugins:link PLUGIN
mingcli plugins:uninstall PLUGIN...
mingcli plugins update
mingcli help [COMMAND]
Display help for mingcli.
USAGE
$ mingcli 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 mingcli.
See code: @oclif/plugin-help
mingcli plugins
List installed plugins.
USAGE
$ mingcli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ mingcli plugins
See code: @oclif/plugin-plugins
mingcli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ mingcli 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
$ mingcli plugins:inspect myplugin
mingcli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ mingcli 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
$ mingcli plugins add
EXAMPLES
$ mingcli plugins:install myplugin
$ mingcli plugins:install https://github.com/someuser/someplugin
$ mingcli plugins:install someuser/someplugin
mingcli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ mingcli 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
$ mingcli plugins:link myplugin
mingcli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ mingcli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mingcli plugins unlink
$ mingcli plugins remove
mingcli plugins update
Update installed plugins.
USAGE
$ mingcli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.