@lwz-fe/cli
v0.0.4
Published
lwz cli
Downloads
3
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @lwz-fe/cli
$ lwz-cli COMMAND
running command...
$ lwz-cli (--version)
@lwz-fe/cli/0.0.4 linux-x64 node-v16.14.2
$ lwz-cli --help [COMMAND]
USAGE
$ lwz-cli COMMAND
...
Commands
lwz-cli hello PERSON
lwz-cli hello world
lwz-cli help [COMMAND]
lwz-cli plugins
lwz-cli plugins:install PLUGIN...
lwz-cli plugins:inspect PLUGIN...
lwz-cli plugins:install PLUGIN...
lwz-cli plugins:link PLUGIN
lwz-cli plugins:uninstall PLUGIN...
lwz-cli plugins:uninstall PLUGIN...
lwz-cli plugins:uninstall PLUGIN...
lwz-cli plugins update
lwz-cli update [CHANNEL]
lwz-cli hello PERSON
Say hello
USAGE
$ lwz-cli hello [PERSON] -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Whom is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: dist/commands/hello/index.ts
lwz-cli hello world
Say hello world
USAGE
$ lwz-cli hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oex hello world
hello world! (./src/commands/hello/world.ts)
lwz-cli help [COMMAND]
Display help for lwz-cli.
USAGE
$ lwz-cli 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 lwz-cli.
See code: @oclif/plugin-help
lwz-cli plugins
List installed plugins.
USAGE
$ lwz-cli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ lwz-cli plugins
See code: @oclif/plugin-plugins
lwz-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ lwz-cli 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
$ lwz-cli plugins add
EXAMPLES
$ lwz-cli plugins:install myplugin
$ lwz-cli plugins:install https://github.com/someuser/someplugin
$ lwz-cli plugins:install someuser/someplugin
lwz-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ lwz-cli 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
$ lwz-cli plugins:inspect myplugin
lwz-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ lwz-cli 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
$ lwz-cli plugins add
EXAMPLES
$ lwz-cli plugins:install myplugin
$ lwz-cli plugins:install https://github.com/someuser/someplugin
$ lwz-cli plugins:install someuser/someplugin
lwz-cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ lwz-cli 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
$ lwz-cli plugins:link myplugin
lwz-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ lwz-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lwz-cli plugins unlink
$ lwz-cli plugins remove
lwz-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ lwz-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lwz-cli plugins unlink
$ lwz-cli plugins remove
lwz-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ lwz-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lwz-cli plugins unlink
$ lwz-cli plugins remove
lwz-cli plugins update
Update installed plugins.
USAGE
$ lwz-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
lwz-cli update [CHANNEL]
update the lwz-cli CLI
USAGE
$ lwz-cli update [CHANNEL] [-a] [-v <value> | -i] [--force]
FLAGS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the lwz-cli CLI
EXAMPLES
Update to the stable channel:
$ lwz-cli update stable
Update to a specific version:
$ lwz-cli update --version 1.0.0
Interactively select version:
$ lwz-cli update --interactive
See available versions:
$ lwz-cli update --available
See code: @oclif/plugin-update