@kkit/cli NPM | npm.io

oclif-hello-world

oclif example Hello World CLI

Usage

$ npm install -g @kkit/cli
$ kk COMMAND
running command...
$ kk (--version)
@kkit/cli/0.0.29 darwin-x64 node-v16.16.0
$ kk --help [COMMAND]
USAGE
  $ kk COMMAND
...

Commands

`kk genidx [PATHS]`

describe the command here

USAGE
  $ kk genidx [PATHS] -e <value> [-p <value>] [-r]

FLAGS
  -e, --extension=<value>  (required) [default: ts] extension to generate index
  -p, --paths=<value>      path to generate index
  -r, --recursive          recursive

DESCRIPTION
  describe the command here

EXAMPLES
  $ kk genidx

See code: dist/commands/genidx.ts

`kk help [COMMAND]`

Display help for kk.

USAGE
  $ kk 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 kk.

See code: @oclif/plugin-help

`kk plugins`

List installed plugins.

USAGE
  $ kk plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ kk plugins

See code: @oclif/plugin-plugins

`kk plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ kk plugins:install myplugin 

  $ kk plugins:install https://github.com/someuser/someplugin

  $ kk plugins:install someuser/someplugin

`kk plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

`kk plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ kk plugins:install myplugin 

  $ kk plugins:install https://github.com/someuser/someplugin

  $ kk plugins:install someuser/someplugin

`kk plugins:link PLUGIN`

Links a plugin into the CLI for development.

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

`kk plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ kk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ kk plugins unlink
  $ kk plugins remove

`kk plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ kk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ kk plugins unlink
  $ kk plugins remove

`kk plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ kk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ kk plugins unlink
  $ kk plugins remove

`kk plugins update`

Update installed plugins.

USAGE
  $ kk plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

`kk update [CHANNEL]`

update the kk CLI

USAGE
  $ kk 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 kk CLI

EXAMPLES
  Update to the stable channel:

    $ kk update stable

  Update to a specific version:

    $ kk update --version 1.0.0

  Interactively select version:

    $ kk update --interactive

  See available versions:

    $ kk update --available

See code: @oclif/plugin-update

oclif

@oclif/core @oclif/plugin-help @oclif/plugin-plugins @oclif/plugin-update @types/prettier @types/ramda lodash prettier ramda ramda-adjunct theredoc

@infinitebrahmanuniverse/nolb-_kk @everything-registry/sub-chunk-521 @zalastax/nolb-_kk

2 years ago

2 years ago

2 years ago

2 years ago