katools

A set of tools to help you focus on what matters most by taking care of the repetitive work.

• Usage
• Commands

Usage

$ npm install -g katools
$ katools COMMAND
running command...
$ katools (--version)
katools/0.4.0 linux-x64 node-v18.20.5
$ katools --help [COMMAND]
USAGE
  $ katools COMMAND
...

Commands

• katools component NAME
• katools entity NAME
• katools help [COMMAND]
• katools init
• katools plugins
• katools plugins add PLUGIN
• katools plugins:inspect PLUGIN...
• katools plugins install PLUGIN
• katools plugins link PATH
• katools plugins remove [PLUGIN]
• katools plugins reset
• katools plugins uninstall [PLUGIN]
• katools plugins unlink [PLUGIN]
• katools plugins update
• katools scene NAME

katools component NAME

Adds a new component to the project

USAGE
  $ katools component NAME

ARGUMENTS
  NAME  name of component

DESCRIPTION
  Adds a new component to the project

EXAMPLES
  $ katools component movement

See code: src/commands/component.ts

katools entity NAME

Adds a new entity to project

USAGE
  $ katools entity NAME

ARGUMENTS
  NAME  name of entity

DESCRIPTION
  Adds a new entity to project

EXAMPLES
  $ katools entity player

See code: src/commands/entity.ts

katools help [COMMAND]

Display help for katools.

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

See code: @oclif/plugin-help

katools init

Initializes a new KAPLAY project.

USAGE
  $ katools init [-n <value>] [-s]

FLAGS
  -n, --name=<value>  [default: katools] name of your game.
  -s, --skip          skip prompts and use default values.

DESCRIPTION
  Initializes a new KAPLAY project.

EXAMPLES
  $ katools init

See code: src/commands/init.ts

katools plugins

List installed plugins.

USAGE
  $ katools plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ katools plugins

See code: @oclif/plugin-plugins

katools plugins add PLUGIN

Installs a plugin into katools.

USAGE
  $ katools plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into katools.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the KATOOLS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the KATOOLS_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ katools plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ katools plugins add myplugin

  Install a plugin from a github url.

    $ katools plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ katools plugins add someuser/someplugin

katools plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

katools plugins install PLUGIN

Installs a plugin into katools.

USAGE
  $ katools plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into katools.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the KATOOLS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the KATOOLS_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ katools plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ katools plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ katools plugins install someuser/someplugin

See code: @oclif/plugin-plugins

katools plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ katools plugins link PATH [-h] [--install] [-v]

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
  $ katools plugins link myplugin

See code: @oclif/plugin-plugins

katools plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ katools plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ katools plugins unlink
  $ katools plugins remove

EXAMPLES
  $ katools plugins remove myplugin

katools plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ katools plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

katools plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ katools plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ katools plugins unlink
  $ katools plugins remove

EXAMPLES
  $ katools plugins uninstall myplugin

See code: @oclif/plugin-plugins

katools plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ katools plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ katools plugins unlink
  $ katools plugins remove

EXAMPLES
  $ katools plugins unlink myplugin

katools plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

katools scene NAME

adds a scene to the project

USAGE
  $ katools scene NAME

ARGUMENTS
  NAME  name of scene

DESCRIPTION
  adds a scene to the project

EXAMPLES
  $ katools scene game

See code: src/commands/scene.ts