oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g soul-engine-cli
$ soul-engine COMMAND
running command...
$ soul-engine (--version)
soul-engine-cli/0.0.8 darwin-arm64 node-v18.17.0
$ soul-engine --help [COMMAND]
USAGE
$ soul-engine COMMAND
...
Commands
soul-engine dev
soul-engine help [COMMANDS]
soul-engine init [PROJECTNAME]
soul-engine login
soul-engine plugins
soul-engine plugins:install PLUGIN...
soul-engine plugins:inspect PLUGIN...
soul-engine plugins:install PLUGIN...
soul-engine plugins:link PLUGIN
soul-engine plugins:uninstall PLUGIN...
soul-engine plugins reset
soul-engine plugins:uninstall PLUGIN...
soul-engine plugins:uninstall PLUGIN...
soul-engine plugins update
soul-engine dev
Hot reload your code for remote chat debug
USAGE
$ soul-engine dev [-l]
FLAGS
-l, --local
DESCRIPTION
Hot reload your code for remote chat debug
EXAMPLES
$ soul-engine dev
See code: src/commands/dev.ts
soul-engine help [COMMANDS]
Display help for soul-engine.
USAGE
$ soul-engine 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 soul-engine.
See code: @oclif/plugin-help
soul-engine init [PROJECTNAME]
Create a new soul engine subroutine
USAGE
$ soul-engine init [PROJECTNAME]
ARGUMENTS
PROJECTNAME The name of the project you want to create.
DESCRIPTION
Create a new soul engine subroutine
EXAMPLES
$ soul-engine init
See code: src/commands/init.ts
soul-engine login
login to the soul engine to provide your CLI with tokens
USAGE
$ soul-engine login [-l]
FLAGS
-l, --local
DESCRIPTION
login to the soul engine to provide your CLI with tokens
EXAMPLES
$ soul-engine login
See code: src/commands/login.ts
soul-engine plugins
List installed plugins.
USAGE
$ soul-engine plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ soul-engine plugins
See code: @oclif/plugin-plugins
soul-engine plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ soul-engine plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
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
$ soul-engine plugins add
EXAMPLES
$ soul-engine plugins add myplugin
$ soul-engine plugins add https://github.com/someuser/someplugin
$ soul-engine plugins add someuser/someplugin
soul-engine plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ soul-engine 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
$ soul-engine plugins inspect myplugin
See code: @oclif/plugin-plugins
soul-engine plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ soul-engine plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
GLOBAL FLAGS
--json Format output as json.
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
$ soul-engine plugins add
EXAMPLES
$ soul-engine plugins install myplugin
$ soul-engine plugins install https://github.com/someuser/someplugin
$ soul-engine plugins install someuser/someplugin
See code: @oclif/plugin-plugins
soul-engine plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ soul-engine plugins:link PLUGIN
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
$ soul-engine plugins link myplugin
See code: @oclif/plugin-plugins
soul-engine plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ soul-engine plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ soul-engine plugins unlink
$ soul-engine plugins remove
EXAMPLES
$ soul-engine plugins remove myplugin
soul-engine plugins reset
Remove all user-installed and linked plugins.
USAGE
$ soul-engine plugins reset
See code: @oclif/plugin-plugins
soul-engine plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ soul-engine plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ soul-engine plugins unlink
$ soul-engine plugins remove
EXAMPLES
$ soul-engine plugins uninstall myplugin
See code: @oclif/plugin-plugins
soul-engine plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ soul-engine plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ soul-engine plugins unlink
$ soul-engine plugins remove
EXAMPLES
$ soul-engine plugins unlink myplugin
soul-engine plugins update
Update installed plugins.
USAGE
$ soul-engine plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins