@kuritkaj/ktools

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @kuritkaj/ktools
$ ktools COMMAND
running command...
$ ktools (--version)
@kuritkaj/ktools/1.4.0 linux-x64 node-v20.0.0
$ ktools --help [COMMAND]
USAGE
  $ ktools COMMAND
...

Commands

• ktools build
• ktools dev
• ktools format
• ktools help [COMMANDS]
• ktools lint
• ktools plugins
• ktools plugins:install PLUGIN...
• ktools plugins:inspect PLUGIN...
• ktools plugins:install PLUGIN...
• ktools plugins:link PLUGIN
• ktools plugins:uninstall PLUGIN...
• ktools plugins:uninstall PLUGIN...
• ktools plugins:uninstall PLUGIN...
• ktools plugins update
• ktools preview
• ktools release

ktools build

Build sources action

USAGE
  $ ktools build [-i <value>] [-h]

FLAGS
  -h, --help                Show CLI help.
  -i, --ignoreFile=<value>  [default: /home/jakub/Projects/kuritkaj/ktools/.gitignore] config file path

DESCRIPTION
  Build sources action

EXAMPLES
  $ ktools build

See code: dist/commands/build/index.js

ktools dev

Run dev server

USAGE
  $ ktools dev [-i <value>] [-h]

FLAGS
  -h, --help                Show CLI help.
  -i, --ignoreFile=<value>  [default: /home/jakub/Projects/kuritkaj/ktools/.gitignore] config file path

DESCRIPTION
  Run dev server

EXAMPLES
  $ ktools dev

See code: dist/commands/dev/index.js

ktools format

Format sources

USAGE
  $ ktools format [-i <value>] [-h]

FLAGS
  -h, --help                Show CLI help.
  -i, --ignoreFile=<value>  [default: /home/jakub/Projects/kuritkaj/ktools/.gitignore] config file path

DESCRIPTION
  Format sources

EXAMPLES
  $ ktools format

See code: dist/commands/format/index.js

ktools help [COMMANDS]

Display help for ktools.

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

See code: @oclif/plugin-help

ktools lint

Lint sources

USAGE
  $ ktools lint [-i <value>] [-h]

FLAGS
  -h, --help                Show CLI help.
  -i, --ignoreFile=<value>  [default: /home/jakub/Projects/kuritkaj/ktools/.gitignore] config file path

DESCRIPTION
  Lint sources

EXAMPLES
  $ ktools lint

See code: dist/commands/lint/index.js

ktools plugins

List installed plugins.

USAGE
  $ ktools plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ ktools plugins

See code: @oclif/plugin-plugins

ktools plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ ktools plugins:install myplugin 

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

  $ ktools plugins:install someuser/someplugin

ktools plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

ktools plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ ktools plugins:install myplugin 

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

  $ ktools plugins:install someuser/someplugin

ktools plugins:link PLUGIN

Links a plugin into the CLI for development.

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

ktools plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ktools plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ktools plugins unlink
  $ ktools plugins remove

ktools plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ktools plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ktools plugins unlink
  $ ktools plugins remove

ktools plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ktools plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ktools plugins unlink
  $ ktools plugins remove

ktools plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

ktools preview

Preview production build

USAGE
  $ ktools preview [-i <value>] [-h]

FLAGS
  -h, --help                Show CLI help.
  -i, --ignoreFile=<value>  [default: /home/jakub/Projects/kuritkaj/ktools/.gitignore] config file path

DESCRIPTION
  Preview production build

EXAMPLES
  $ ktools preview

See code: dist/commands/preview/index.js

ktools release

Release sources action

USAGE
  $ ktools release [-i <value>] [-h]

FLAGS
  -h, --help                Show CLI help.
  -i, --ignoreFile=<value>  [default: /home/jakub/Projects/kuritkaj/ktools/.gitignore] config file path

DESCRIPTION
  Release sources action

EXAMPLES
  $ ktools release

See code: dist/commands/release/index.js