@clai-pkg/cli
v0.0.1
Published
CLI ❤️ AI
Downloads
4
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @clai-pkg/cli
$ clai COMMAND
running command...
$ clai (--version)
@clai-pkg/cli/0.0.1 darwin-arm64 node-v18.17.1
$ clai --help [COMMAND]
USAGE
$ clai COMMAND
...
Commands
clai hello PERSON
clai hello world
clai help [COMMANDS]
clai plugins
clai plugins:install PLUGIN...
clai plugins:inspect PLUGIN...
clai plugins:install PLUGIN...
clai plugins:link PLUGIN
clai plugins:uninstall PLUGIN...
clai plugins reset
clai plugins:uninstall PLUGIN...
clai plugins:uninstall PLUGIN...
clai plugins update
clai hello PERSON
Say hello
USAGE
$ clai hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: src/commands/hello/index.ts
clai hello world
Say hello world
USAGE
$ clai hello world
DESCRIPTION
Say hello world
EXAMPLES
$ clai hello world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/hello/world.ts
clai help [COMMANDS]
Display help for clai.
USAGE
$ clai 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 clai.
See code: @oclif/plugin-help
clai plugins
List installed plugins.
USAGE
$ clai plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ clai plugins
See code: @oclif/plugin-plugins
clai plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ clai 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
$ clai plugins add
EXAMPLES
$ clai plugins:install myplugin
$ clai plugins:install https://github.com/someuser/someplugin
$ clai plugins:install someuser/someplugin
clai plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ clai 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
$ clai plugins:inspect myplugin
See code: @oclif/plugin-plugins
clai plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ clai 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
$ clai plugins add
EXAMPLES
$ clai plugins:install myplugin
$ clai plugins:install https://github.com/someuser/someplugin
$ clai plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
clai plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ clai 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
$ clai plugins:link myplugin
See code: @oclif/plugin-plugins
clai plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ clai plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ clai plugins unlink
$ clai plugins remove
clai plugins reset
Remove all user-installed and linked plugins.
USAGE
$ clai plugins reset
See code: @oclif/plugin-plugins
clai plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ clai plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ clai plugins unlink
$ clai plugins remove
See code: @oclif/plugin-plugins
clai plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ clai plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ clai plugins unlink
$ clai plugins remove
clai plugins update
Update installed plugins.
USAGE
$ clai plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins