pz-cli
v0.0.1
Published
PZ helper
Downloads
2
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g pz-cli
$ pz COMMAND
running command...
$ pz (--version)
pz-cli/0.0.1 win32-x64 node-v20.5.0
$ pz --help [COMMAND]
USAGE
$ pz COMMAND
...
Commands
pz backup [PATH]
pz help [COMMANDS]
pz plugins
pz plugins:install PLUGIN...
pz plugins:inspect PLUGIN...
pz plugins:install PLUGIN...
pz plugins:link PLUGIN
pz plugins:uninstall PLUGIN...
pz plugins reset
pz plugins:uninstall PLUGIN...
pz plugins:uninstall PLUGIN...
pz plugins update
pz backup [PATH]
Backup the latest save game
USAGE
$ pz backup [PATH]
ARGUMENTS
PATH PZ binary path to backup games for. Uses %UserData% default path if not provided
DESCRIPTION
Backup the latest save game
EXAMPLES
$ pz backup G:/Games/ProjectZomboid
See code: dist/commands/backup/index.ts
pz help [COMMANDS]
Display help for pz.
USAGE
$ pz help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for pz.
See code: @oclif/plugin-help
pz plugins
List installed plugins.
USAGE
$ pz plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ pz plugins
See code: @oclif/plugin-plugins
pz plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ pz plugins add plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
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
$ pz plugins add
EXAMPLES
$ pz plugins add myplugin
$ pz plugins add https://github.com/someuser/someplugin
$ pz plugins add someuser/someplugin
pz plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ pz 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
$ pz plugins inspect myplugin
See code: @oclif/plugin-plugins
pz plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ pz plugins install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
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
$ pz plugins add
EXAMPLES
$ pz plugins install myplugin
$ pz plugins install https://github.com/someuser/someplugin
$ pz plugins install someuser/someplugin
See code: @oclif/plugin-plugins
pz plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ pz plugins link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
$ pz plugins link myplugin
See code: @oclif/plugin-plugins
pz plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pz plugins remove plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pz plugins unlink
$ pz plugins remove
EXAMPLES
$ pz plugins remove myplugin
pz plugins reset
Remove all user-installed and linked plugins.
USAGE
$ pz plugins reset
See code: @oclif/plugin-plugins
pz plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pz plugins uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pz plugins unlink
$ pz plugins remove
EXAMPLES
$ pz plugins uninstall myplugin
See code: @oclif/plugin-plugins
pz plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ pz plugins unlink plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ pz plugins unlink
$ pz plugins remove
EXAMPLES
$ pz plugins unlink myplugin
pz plugins update
Update installed plugins.
USAGE
$ pz plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins