@kokimoki/cli v0.6.1

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @kokimoki/cli
$ kokimoki COMMAND
running command...
$ kokimoki (--version)
@kokimoki/cli/0.6.1 linux-x64 node-v22.2.0
$ kokimoki --help [COMMAND]
USAGE
  $ kokimoki COMMAND
...

Commands

• kokimoki credentials
• kokimoki help [COMMANDS]
• kokimoki login
• kokimoki logout
• kokimoki plugins
• kokimoki plugins:install PLUGIN...
• kokimoki plugins:inspect PLUGIN...
• kokimoki plugins:install PLUGIN...
• kokimoki plugins:link PLUGIN
• kokimoki plugins:uninstall PLUGIN...
• kokimoki plugins:uninstall PLUGIN...
• kokimoki plugins:uninstall PLUGIN...
• kokimoki plugins update
• kokimoki prepare-dev-env [PREFIX]
• kokimoki upload [PREFIX]

kokimoki credentials

delete credentials

USAGE
  $ kokimoki credentials [-e <value>]

FLAGS
  -e, --endpoint=<value>  [default: https://api.kokimoki.com] Kokimoki endpoint

DESCRIPTION
  delete credentials

EXAMPLES
  $ kokimoki credentials

See code: dist/commands/credentials.ts

kokimoki help [COMMANDS]

Display help for kokimoki.

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

See code: @oclif/plugin-help

kokimoki login

login using api key

USAGE
  $ kokimoki login [-e <value>]

FLAGS
  -e, --endpoint=<value>  [default: https://api.kokimoki.com] Kokimoki endpoint

DESCRIPTION
  login using api key

EXAMPLES
  $ kokimoki login

See code: dist/commands/login.ts

kokimoki logout

delete credentials

USAGE
  $ kokimoki logout [-e <value>]

FLAGS
  -e, --endpoint=<value>  [default: https://api.kokimoki.com] Kokimoki endpoint

DESCRIPTION
  delete credentials

EXAMPLES
  $ kokimoki logout

See code: dist/commands/logout.ts

kokimoki plugins

List installed plugins.

USAGE
  $ kokimoki plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ kokimoki plugins

See code: @oclif/plugin-plugins

kokimoki plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ kokimoki plugins:install myplugin 

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

  $ kokimoki plugins:install someuser/someplugin

kokimoki plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

kokimoki plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ kokimoki plugins:install myplugin 

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

  $ kokimoki plugins:install someuser/someplugin

kokimoki plugins:link PLUGIN

Links a plugin into the CLI for development.

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

kokimoki plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ kokimoki plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ kokimoki plugins unlink
  $ kokimoki plugins remove

kokimoki plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ kokimoki plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ kokimoki plugins unlink
  $ kokimoki plugins remove

kokimoki plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ kokimoki plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ kokimoki plugins unlink
  $ kokimoki plugins remove

kokimoki plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

kokimoki prepare-dev-env [PREFIX]

prepare local .env for development

USAGE
  $ kokimoki prepare-dev-env [PREFIX]

ARGUMENTS
  PREFIX  [default: /home/gutnar/Projects/kokimoki/kokimoki-sdk/packages/cli] path to project directory

DESCRIPTION
  prepare local .env for development

EXAMPLES
  $ kokimoki prepare-dev-env

See code: dist/commands/prepare-dev-env.ts

kokimoki upload [PREFIX]

upload project to Kokimoki store

USAGE
  $ kokimoki upload [PREFIX] [-e <value>]

ARGUMENTS
  PREFIX  [default: ./] path to project directory

FLAGS
  -e, --endpoint=<value>  [default: https://api.kokimoki.com] Kokimoki endpoint

DESCRIPTION
  upload project to Kokimoki store

EXAMPLES
  $ kokimoki upload

See code: dist/commands/upload.ts