npm package: @kokimoki/cli
Description: Kokimoki CLI
Author: Loquiz OÜ
Latest version: 0.8.0

# oclif-hello-world

oclif example Hello World CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE)

<!-- toc -->
* [oclif-hello-world](#oclif-hello-world)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @kokimoki/cli
$ kokimoki COMMAND
running command...
$ kokimoki (--version)
@kokimoki/cli/0.8.0 darwin-arm64 node-v22.10.0
$ kokimoki --help [COMMAND]
USAGE
  $ kokimoki COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`kokimoki credentials`](#kokimoki-credentials)
* [`kokimoki help [COMMANDS]`](#kokimoki-help-commands)
* [`kokimoki login`](#kokimoki-login)
* [`kokimoki logout`](#kokimoki-logout)
* [`kokimoki new [NAME]`](#kokimoki-new-name)
* [`kokimoki plugins`](#kokimoki-plugins)
* [`kokimoki plugins:install PLUGIN...`](#kokimoki-pluginsinstall-plugin)
* [`kokimoki plugins:inspect PLUGIN...`](#kokimoki-pluginsinspect-plugin)
* [`kokimoki plugins:install PLUGIN...`](#kokimoki-pluginsinstall-plugin-1)
* [`kokimoki plugins:link PLUGIN`](#kokimoki-pluginslink-plugin)
* [`kokimoki plugins:uninstall PLUGIN...`](#kokimoki-pluginsuninstall-plugin)
* [`kokimoki plugins:uninstall PLUGIN...`](#kokimoki-pluginsuninstall-plugin-1)
* [`kokimoki plugins:uninstall PLUGIN...`](#kokimoki-pluginsuninstall-plugin-2)
* [`kokimoki plugins update`](#kokimoki-plugins-update)
* [`kokimoki prepare-dev-env [PREFIX]`](#kokimoki-prepare-dev-env-prefix)
* [`kokimoki upload [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: [src/commands/credentials.ts](https://github.com/kokimoki/cli/blob/v0.8.0/src/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](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_

## `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: [src/commands/login.ts](https://github.com/kokimoki/cli/blob/v0.8.0/src/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: [src/commands/logout.ts](https://github.com/kokimoki/cli/blob/v0.8.0/src/commands/logout.ts)_

## `kokimoki new [NAME]`

create a new Kokimoki concept from template

```
USAGE
  $ kokimoki new [NAME] [-t <value>] [-b <value>] [-e <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: [src/commands/new.ts](https://github.com/kokimoki/cli/blob/v0.8.0/src/commands/new.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](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_

## `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
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/inspect.ts)_

## `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
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/install.ts)_

## `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
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/link.ts)_

## `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
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/uninstall.ts)_

## `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.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/update.ts)_

## `kokimoki prepare-dev-env [PREFIX]`

prepare local .env for development

```
USAGE
  $ kokimoki prepare-dev-env [PREFIX]

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

DESCRIPTION
  prepare local .env for development

EXAMPLES
  $ kokimoki prepare-dev-env
```

_See code: [src/commands/prepare-dev-env.ts](https://github.com/kokimoki/cli/blob/v0.8.0/src/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: [src/commands/upload.ts](https://github.com/kokimoki/cli/blob/v0.8.0/src/commands/upload.ts)_
<!-- commandsstop -->