oclif-hello-world

oclif example Hello World CLI

• oclif-hello-world
• Usage
• Commands

Usage

$ npm install -g @kokimoki/cli
$ kokimoki COMMAND
running command...
$ kokimoki (--version)
@kokimoki/cli/0.9.3 darwin-arm64 node-v22.22.3
$ kokimoki --help [COMMAND]
USAGE
  $ kokimoki COMMAND
...

Commands

• kokimoki credentials
• kokimoki help [COMMAND]
• kokimoki login
• kokimoki logout
• kokimoki new [NAME]
• kokimoki plugins
• kokimoki plugins add PLUGIN
• kokimoki plugins:inspect PLUGIN...
• kokimoki plugins install PLUGIN
• kokimoki plugins link PATH
• kokimoki plugins remove [PLUGIN]
• kokimoki plugins reset
• kokimoki plugins uninstall [PLUGIN]
• kokimoki plugins unlink [PLUGIN]
• kokimoki plugins update
• kokimoki prepare-dev-env [PREFIX]
• kokimoki upload [PREFIX]
• kokimoki validate [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.js

kokimoki help [COMMAND]

Display help for kokimoki.

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

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.js

kokimoki new [NAME]

create a new Kokimoki concept from template

USAGE
  $ kokimoki new [NAME] [-b <value>] [-e <value>] [-t <value>]

ARGUMENTS
  [NAME]  concept name

FLAGS
  -b, --branch=<value>    Template repository branch
  -e, --endpoint=<value>  [default: https://api.kokimoki.com] Kokimoki endpoint
  -t, --template=<value>  [default: https://github.com/kokimoki/host-starter-template.git] Template repository URL

DESCRIPTION
  create a new Kokimoki concept from template

EXAMPLES
  $ kokimoki new

  $ kokimoki new my-concept

  $ kokimoki new my-concept --template custom-template

See code: dist/commands/new.js

kokimoki plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ kokimoki plugins

See code: @oclif/plugin-plugins

kokimoki plugins add PLUGIN

Installs a plugin into kokimoki.

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

  Uses npm to install plugins.

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

  Use the KOKIMOKI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the KOKIMOKI_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ kokimoki plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ kokimoki plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

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

See code: @oclif/plugin-plugins

kokimoki plugins install PLUGIN

Installs a plugin into kokimoki.

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

  Uses npm to install plugins.

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

  Use the KOKIMOKI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the KOKIMOKI_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ kokimoki plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ kokimoki plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ kokimoki plugins install someuser/someplugin

See code: @oclif/plugin-plugins

kokimoki plugins link PATH

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

kokimoki plugins remove [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ kokimoki plugins remove myplugin

kokimoki plugins reset

Remove all user-installed and linked plugins.

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

kokimoki plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ kokimoki plugins uninstall myplugin

See code: @oclif/plugin-plugins

kokimoki plugins unlink [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ kokimoki plugins unlink myplugin

kokimoki plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

kokimoki prepare-dev-env [PREFIX]

prepare local .env for development

USAGE
  $ kokimoki prepare-dev-env [PREFIX]

ARGUMENTS
  [PREFIX]  [default: /Users/mikhailo/Developer/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.js

kokimoki upload [PREFIX]

upload project to Kokimoki store

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

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

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

DESCRIPTION
  upload project to Kokimoki store

EXAMPLES
  $ kokimoki upload

See code: dist/commands/upload.js

kokimoki validate [PREFIX]

validate concept for common issues

USAGE
  $ kokimoki validate [PREFIX] [-d] [-i] [-r] [-s]

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

FLAGS
  -d, --dangerous  Run dangerous patterns check
  -i, --i18n       Run i18n validation check
  -r, --requests   Run external requests check
  -s, --secrets    Run secrets check

DESCRIPTION
  validate concept for common issues

EXAMPLES
  $ kokimoki validate

  $ kokimoki validate -s -r

  $ kokimoki validate --secrets --requests

See code: dist/commands/validate.js