1.2.0 • Published 2 years ago
pz-hello-world v1.2.0
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g pz-hello-world
$ pzhw COMMAND
running command...
$ pzhw (--version)
pz-hello-world/1.1.3 linux-x64 node-v14.17.0
$ pzhw --help [COMMAND]
USAGE
$ pzhw COMMAND
...
Commands
pzhw autocomplete [SHELL]
pzhw hello PERSON
pzhw hello world
pzhw help [COMMAND]
pzhw plugins
pzhw plugins:install PLUGIN...
pzhw plugins:inspect PLUGIN...
pzhw plugins:install PLUGIN...
pzhw plugins:link PLUGIN
pzhw plugins:uninstall PLUGIN...
pzhw plugins:uninstall PLUGIN...
pzhw plugins:uninstall PLUGIN...
pzhw plugins update
pzhw update [CHANNEL]
pzhw autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ pzhw autocomplete [SHELL] [-r]
ARGUMENTS
SHELL shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
display autocomplete installation instructions
EXAMPLES
$ pzhw autocomplete
$ pzhw autocomplete bash
$ pzhw autocomplete zsh
$ pzhw autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
pzhw hello PERSON
Say hello
USAGE
$ pzhw hello [PERSON] -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Whom is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ pzhw hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: dist/commands/hello/index.ts
pzhw hello world
Say new 1.1.3 hello world
USAGE
$ pzhw hello world
DESCRIPTION
Say new 1.1.3 hello world
EXAMPLES
$ pzhw hello world
hello world! (./src/commands/hello/world.ts)
pzhw help [COMMAND]
Display help for pzhw.
USAGE
$ pzhw 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 pzhw.
See code: @oclif/plugin-help
pzhw plugins
List installed plugins.
USAGE
$ pzhw plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ pzhw plugins
See code: @oclif/plugin-plugins
pzhw plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ pzhw 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
$ pzhw plugins add
EXAMPLES
$ pzhw plugins:install myplugin
$ pzhw plugins:install https://github.com/someuser/someplugin
$ pzhw plugins:install someuser/someplugin
pzhw plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ pzhw 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
$ pzhw plugins:inspect myplugin
pzhw plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ pzhw 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
$ pzhw plugins add
EXAMPLES
$ pzhw plugins:install myplugin
$ pzhw plugins:install https://github.com/someuser/someplugin
$ pzhw plugins:install someuser/someplugin
pzhw plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ pzhw 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
$ pzhw plugins:link myplugin
pzhw plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pzhw plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pzhw plugins unlink
$ pzhw plugins remove
pzhw plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pzhw plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pzhw plugins unlink
$ pzhw plugins remove
pzhw plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pzhw plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pzhw plugins unlink
$ pzhw plugins remove
pzhw plugins update
Update installed plugins.
USAGE
$ pzhw plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
pzhw update [CHANNEL]
update the pzhw CLI
USAGE
$ pzhw 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 pzhw CLI
EXAMPLES
Update to the stable channel:
$ pzhw update stable
Update to a specific version:
$ pzhw update --version 1.0.0
Interactively select version:
$ pzhw update --interactive
See available versions:
$ pzhw update --available
See code: @oclif/plugin-update