0.1.0 • Published 2 years ago
oscar.sanz.custom-cli v0.1.0
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g oscar.sanz.custom-cli
$ custom-cli COMMAND
running command...
$ custom-cli (--version)
oscar.sanz.custom-cli/0.1.0 linux-x64 node-v16.13.2
$ custom-cli --help [COMMAND]
USAGE
$ custom-cli COMMAND
...
Commands
custom-cli help [COMMAND]
custom-cli plugins
custom-cli plugins:install PLUGIN...
custom-cli plugins:inspect PLUGIN...
custom-cli plugins:install PLUGIN...
custom-cli plugins:link PLUGIN
custom-cli plugins:uninstall PLUGIN...
custom-cli plugins:uninstall PLUGIN...
custom-cli plugins:uninstall PLUGIN...
custom-cli plugins update
custom-cli seed
custom-cli help [COMMAND]
Display help for custom-cli.
USAGE
$ custom-cli 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 custom-cli.
See code: @oclif/plugin-help
custom-cli plugins
List installed plugins.
USAGE
$ custom-cli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ custom-cli plugins
See code: @oclif/plugin-plugins
custom-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ custom-cli 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
$ custom-cli plugins add
EXAMPLES
$ custom-cli plugins:install myplugin
$ custom-cli plugins:install https://github.com/someuser/someplugin
$ custom-cli plugins:install someuser/someplugin
custom-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ custom-cli plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ custom-cli plugins:inspect myplugin
custom-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ custom-cli 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
$ custom-cli plugins add
EXAMPLES
$ custom-cli plugins:install myplugin
$ custom-cli plugins:install https://github.com/someuser/someplugin
$ custom-cli plugins:install someuser/someplugin
custom-cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ custom-cli 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
$ custom-cli plugins:link myplugin
custom-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ custom-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cli plugins unlink
$ custom-cli plugins remove
custom-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ custom-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cli plugins unlink
$ custom-cli plugins remove
custom-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ custom-cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ custom-cli plugins unlink
$ custom-cli plugins remove
custom-cli plugins update
Update installed plugins.
USAGE
$ custom-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
custom-cli seed
describe the command here
USAGE
$ custom-cli seed
DESCRIPTION
describe the command here
See code: dist/commands/seed.ts
0.1.0
2 years ago