@cognizone/cli v4.1.1

cz-cli

cz-cli

• Usage
• Commands

Usage

$ npm install -g @cognizone/cli
$ cz-cli COMMAND
running command...
$ cz-cli (--version)
@cognizone/cli/3.12.4 linux-x64 node-v18.19.1
$ cz-cli --help [COMMAND]
USAGE
  $ cz-cli COMMAND
...

Commands

• cz-cli help [COMMAND]
• cz-cli plugins
• cz-cli plugins:install PLUGIN...
• cz-cli plugins:inspect PLUGIN...
• cz-cli plugins:install PLUGIN...
• cz-cli plugins:link PLUGIN
• cz-cli plugins:uninstall PLUGIN...
• cz-cli plugins:uninstall PLUGIN...
• cz-cli plugins:uninstall PLUGIN...
• cz-cli plugins update

cz-cli help [COMMAND]

Display help for cz-cli.

USAGE
  $ cz-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 cz-cli.

See code: @oclif/plugin-help

cz-cli plugins

List installed plugins.

USAGE
  $ cz-cli plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ cz-cli plugins

See code: @oclif/plugin-plugins

cz-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ cz-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
  $ cz-cli plugins add

EXAMPLES
  $ cz-cli plugins:install myplugin 

  $ cz-cli plugins:install https://github.com/someuser/someplugin

  $ cz-cli plugins:install someuser/someplugin

cz-cli plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ cz-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
  $ cz-cli plugins:inspect myplugin

cz-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ cz-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
  $ cz-cli plugins add

EXAMPLES
  $ cz-cli plugins:install myplugin 

  $ cz-cli plugins:install https://github.com/someuser/someplugin

  $ cz-cli plugins:install someuser/someplugin

cz-cli plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ cz-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
  $ cz-cli plugins:link myplugin

cz-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cz-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
  $ cz-cli plugins unlink
  $ cz-cli plugins remove

cz-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cz-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
  $ cz-cli plugins unlink
  $ cz-cli plugins remove

cz-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ cz-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
  $ cz-cli plugins unlink
  $ cz-cli plugins remove

cz-cli plugins update

Update installed plugins.

USAGE
  $ cz-cli plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.