@kinotic-ai/kinotic-cli
v2.1.2
Published
Kinotic CLI provides the ability to build, deploy, and manage Kinotic applications that run on the Kinotic OS.
Readme
Structures CLI
Usage
$ npm install -g @kinotic-ai/kinotic-cli
$ kinotic COMMAND
running command...
$ kinotic (--version)
@kinotic-ai/kinotic-cli/2.1.2 darwin-arm64 node-v22.13.1
$ kinotic --help [COMMAND]
USAGE
$ kinotic COMMAND
...Commands
kinotic autocomplete [SHELL]kinotic create project NAMEkinotic genkinotic generatekinotic help [COMMAND]kinotic initkinotic initializekinotic pluginskinotic plugins add PLUGINkinotic plugins:inspect PLUGIN...kinotic plugins install PLUGINkinotic plugins link PATHkinotic plugins remove [PLUGIN]kinotic plugins resetkinotic plugins uninstall [PLUGIN]kinotic plugins unlink [PLUGIN]kinotic plugins updatekinotic synckinotic synchronizekinotic update [CHANNEL]
kinotic autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ kinotic autocomplete [SHELL] [-r]
ARGUMENTS
[SHELL] (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ kinotic autocomplete
$ kinotic autocomplete bash
$ kinotic autocomplete zsh
$ kinotic autocomplete powershell
$ kinotic autocomplete --refresh-cacheSee code: @oclif/plugin-autocomplete
kinotic create project NAME
Creates a Kinotic Project
USAGE
$ kinotic create project NAME
ARGUMENTS
NAME The name for the project
DESCRIPTION
Creates a Kinotic Project
EXAMPLES
$ kinotic create project MyProjectNameSee code: src/commands/create/project.ts
kinotic gen
This will generate all Repository classes.
USAGE
$ kinotic gen [-v] [-f]
FLAGS
-f, --force Force full regeneration, ignoring incremental change detection
-v, --verbose Enable verbose logging
DESCRIPTION
This will generate all Repository classes.
ALIASES
$ kinotic gen
EXAMPLES
$ kinotic generate
$ kinotic gen
$ kinotic gen -v
$ kinotic gen --forcekinotic generate
This will generate all Repository classes.
USAGE
$ kinotic generate [-v] [-f]
FLAGS
-f, --force Force full regeneration, ignoring incremental change detection
-v, --verbose Enable verbose logging
DESCRIPTION
This will generate all Repository classes.
ALIASES
$ kinotic gen
EXAMPLES
$ kinotic generate
$ kinotic gen
$ kinotic gen -v
$ kinotic gen --forceSee code: src/commands/generate.ts
kinotic help [COMMAND]
Display help for kinotic.
USAGE
$ kinotic 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 kinotic.See code: @oclif/plugin-help
kinotic init
This will initialize a new Kinotic Project for use with the Kinotic CLI.
USAGE
$ kinotic init [-a <value>] [-e <value>] [-r <value>] [-m]
FLAGS
-a, --application=<value> The name of the application you want to use
-e, --entities=<value> Path to the directory containing the Entity definitions
-m, --mirror Mirror the entity folder structure under the repository path
-r, --repository=<value> Path to the directory to write generated Repository classes
DESCRIPTION
This will initialize a new Kinotic Project for use with the Kinotic CLI.
ALIASES
$ kinotic init
EXAMPLES
$ kinotic initialize --application my.app --entities path/to/entities --repository path/to/repository
$ kinotic init --application my.app --entities path/to/entities --repository path/to/repository
$ kinotic init -a my.app -e path/to/entities -r path/to/repository
$ kinotic init -a my.app -e path/to/entities -r path/to/repository --mirrorkinotic initialize
This will initialize a new Kinotic Project for use with the Kinotic CLI.
USAGE
$ kinotic initialize [-a <value>] [-e <value>] [-r <value>] [-m]
FLAGS
-a, --application=<value> The name of the application you want to use
-e, --entities=<value> Path to the directory containing the Entity definitions
-m, --mirror Mirror the entity folder structure under the repository path
-r, --repository=<value> Path to the directory to write generated Repository classes
DESCRIPTION
This will initialize a new Kinotic Project for use with the Kinotic CLI.
ALIASES
$ kinotic init
EXAMPLES
$ kinotic initialize --application my.app --entities path/to/entities --repository path/to/repository
$ kinotic init --application my.app --entities path/to/entities --repository path/to/repository
$ kinotic init -a my.app -e path/to/entities -r path/to/repository
$ kinotic init -a my.app -e path/to/entities -r path/to/repository --mirrorSee code: src/commands/initialize.ts
kinotic plugins
List installed plugins.
USAGE
$ kinotic plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ kinotic pluginsSee code: @oclif/plugin-plugins
kinotic plugins add PLUGIN
Installs a plugin into kinotic.
USAGE
$ kinotic 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 kinotic.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the KINOTIC_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the KINOTIC_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ kinotic plugins add
EXAMPLES
Install a plugin from npm registry.
$ kinotic plugins add myplugin
Install a plugin from a github url.
$ kinotic plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ kinotic plugins add someuser/somepluginkinotic plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ kinotic 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
$ kinotic plugins inspect mypluginSee code: @oclif/plugin-plugins
kinotic plugins install PLUGIN
Installs a plugin into kinotic.
USAGE
$ kinotic 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 kinotic.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the KINOTIC_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the KINOTIC_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ kinotic plugins add
EXAMPLES
Install a plugin from npm registry.
$ kinotic plugins install myplugin
Install a plugin from a github url.
$ kinotic plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ kinotic plugins install someuser/somepluginSee code: @oclif/plugin-plugins
kinotic plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ kinotic 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
$ kinotic plugins link mypluginSee code: @oclif/plugin-plugins
kinotic plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ kinotic 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
$ kinotic plugins unlink
$ kinotic plugins remove
EXAMPLES
$ kinotic plugins remove mypluginkinotic plugins reset
Remove all user-installed and linked plugins.
USAGE
$ kinotic 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
kinotic plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ kinotic 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
$ kinotic plugins unlink
$ kinotic plugins remove
EXAMPLES
$ kinotic plugins uninstall mypluginSee code: @oclif/plugin-plugins
kinotic plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ kinotic 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
$ kinotic plugins unlink
$ kinotic plugins remove
EXAMPLES
$ kinotic plugins unlink mypluginkinotic plugins update
Update installed plugins.
USAGE
$ kinotic plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
kinotic sync
Synchronize the local Entity definitions with the Kinotic Server
USAGE
$ kinotic sync [-s <value>] [-p] [-v] [-f <value>] [--dryRun] [--force]
FLAGS
-f, --authHeaderFile=<value> JSON File containing authentication headers
-p, --publish Publish each Entity after save/update
-s, --server=<value> The Kinotic server to connect to
-v, --verbose Enable verbose logging
--dryRun Dry run enables verbose logging and does not save any changes to the server
--force Force full regeneration, ignoring incremental change detection
DESCRIPTION
Synchronize the local Entity definitions with the Kinotic Server
ALIASES
$ kinotic sync
EXAMPLES
$ kinotic synchronize
$ kinotic sync
$ kinotic synchronize --server http://localhost:9090 --publish --verbose
$ kinotic sync -p -v -s http://localhost:9090kinotic synchronize
Synchronize the local Entity definitions with the Kinotic Server
USAGE
$ kinotic synchronize [-s <value>] [-p] [-v] [-f <value>] [--dryRun] [--force]
FLAGS
-f, --authHeaderFile=<value> JSON File containing authentication headers
-p, --publish Publish each Entity after save/update
-s, --server=<value> The Kinotic server to connect to
-v, --verbose Enable verbose logging
--dryRun Dry run enables verbose logging and does not save any changes to the server
--force Force full regeneration, ignoring incremental change detection
DESCRIPTION
Synchronize the local Entity definitions with the Kinotic Server
ALIASES
$ kinotic sync
EXAMPLES
$ kinotic synchronize
$ kinotic sync
$ kinotic synchronize --server http://localhost:9090 --publish --verbose
$ kinotic sync -p -v -s http://localhost:9090See code: src/commands/synchronize.ts
kinotic update [CHANNEL]
update the kinotic CLI
USAGE
$ kinotic update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
FLAGS
-a, --available See available versions.
-b, --verbose Show more details about the available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the kinotic CLI
EXAMPLES
Update to the stable channel:
$ kinotic update stable
Update to a specific version:
$ kinotic update --version 1.0.0
Interactively select version:
$ kinotic update --interactive
See available versions:
$ kinotic update --availableSee code: @oclif/plugin-update
