1.0.0 • Published 2 years ago

@coaktion/common-zendesk-commands v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

common-zendesk-commands

A library of common commands for Zendesk apps

Usage

$ npm install -g @coaktion/common-zendesk-commands
$ common-zendesk-commands COMMAND
running command...
$ common-zendesk-commands (--version)
@coaktion/common-zendesk-commands/1.0.0 linux-x64 node-v16.20.1
$ common-zendesk-commands --help [COMMAND]
USAGE
  $ common-zendesk-commands COMMAND
...

Commands

common-zendesk-commands dev

Starts the app in Zendesk development mode

USAGE
  $ common-zendesk-commands dev

DESCRIPTION
  Starts the app in Zendesk development mode

EXAMPLES
  $ common-zendesk-commands dev

See code: dist/commands/dev.ts

common-zendesk-commands generate-config

Generates a zcli.apps.config.json file

USAGE
  $ common-zendesk-commands generate-config

DESCRIPTION
  Generates a zcli.apps.config.json file

EXAMPLES
  $ common-zendesk-commands generate-config

See code: dist/commands/generate-config.ts

common-zendesk-commands help [COMMANDS]

Display help for common-zendesk-commands.

USAGE
  $ common-zendesk-commands 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 common-zendesk-commands.

See code: @oclif/plugin-help

common-zendesk-commands plugins

List installed plugins.

USAGE
  $ common-zendesk-commands plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ common-zendesk-commands plugins

See code: @oclif/plugin-plugins

common-zendesk-commands plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ common-zendesk-commands 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
  $ common-zendesk-commands plugins add

EXAMPLES
  $ common-zendesk-commands plugins:install myplugin 

  $ common-zendesk-commands plugins:install https://github.com/someuser/someplugin

  $ common-zendesk-commands plugins:install someuser/someplugin

common-zendesk-commands plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ common-zendesk-commands 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
  $ common-zendesk-commands plugins:inspect myplugin

common-zendesk-commands plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ common-zendesk-commands 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
  $ common-zendesk-commands plugins add

EXAMPLES
  $ common-zendesk-commands plugins:install myplugin 

  $ common-zendesk-commands plugins:install https://github.com/someuser/someplugin

  $ common-zendesk-commands plugins:install someuser/someplugin

common-zendesk-commands plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ common-zendesk-commands 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
  $ common-zendesk-commands plugins:link myplugin

common-zendesk-commands plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ common-zendesk-commands plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ common-zendesk-commands plugins unlink
  $ common-zendesk-commands plugins remove

common-zendesk-commands plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ common-zendesk-commands plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ common-zendesk-commands plugins unlink
  $ common-zendesk-commands plugins remove

common-zendesk-commands plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ common-zendesk-commands plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ common-zendesk-commands plugins unlink
  $ common-zendesk-commands plugins remove

common-zendesk-commands plugins update

Update installed plugins.

USAGE
  $ common-zendesk-commands plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

common-zendesk-commands publish

Creates or updates the app in Zendesk

USAGE
  $ common-zendesk-commands publish

DESCRIPTION
  Creates or updates the app in Zendesk

EXAMPLES
  $ common-zendesk-commands publish

See code: dist/commands/publish.ts

oclif
@oclif/core@oclif/plugin-help@zendesk/zcli
@everything-registry/sub-chunk-181
1.0.0

2 years ago

0.5.0

2 years ago

0.4.0

2 years ago

0.3.0

2 years ago

0.2.0

2 years ago

0.1.0

2 years ago