0.0.2 • Published 8 months ago
yycu-generate v0.0.2
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g yycu-generate
$ cc COMMAND
running command...
$ cc (--version)
yycu-generate/0.0.2 linux-x64 node-v16.20.1
$ cc --help [COMMAND]
USAGE
$ cc COMMAND
...
Commands
cc generate [FILE]
cc help [COMMANDS]
cc plugins
cc plugins:install PLUGIN...
cc plugins:inspect PLUGIN...
cc plugins:install PLUGIN...
cc plugins:link PLUGIN
cc plugins:uninstall PLUGIN...
cc plugins:uninstall PLUGIN...
cc plugins:uninstall PLUGIN...
cc plugins update
cc generate [FILE]
describe the command here
USAGE
$ cc generate [FILE] [-n <value>] [-f]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ cc generate
See code: dist/commands/generate.ts
cc help [COMMANDS]
Display help for cc.
USAGE
$ cc 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 cc.
See code: @oclif/plugin-help
cc plugins
List installed plugins.
USAGE
$ cc plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ cc plugins
See code: @oclif/plugin-plugins
cc plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ cc 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
$ cc plugins add
EXAMPLES
$ cc plugins:install myplugin
$ cc plugins:install https://github.com/someuser/someplugin
$ cc plugins:install someuser/someplugin
cc plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ cc 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
$ cc plugins:inspect myplugin
See code: @oclif/plugin-plugins
cc plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ cc 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
$ cc plugins add
EXAMPLES
$ cc plugins:install myplugin
$ cc plugins:install https://github.com/someuser/someplugin
$ cc plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
cc plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ cc 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
$ cc plugins:link myplugin
See code: @oclif/plugin-plugins
cc plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cc plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cc plugins unlink
$ cc plugins remove
cc plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cc plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cc plugins unlink
$ cc plugins remove
See code: @oclif/plugin-plugins
cc plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cc plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cc plugins unlink
$ cc plugins remove
cc plugins update
Update installed plugins.
USAGE
$ cc plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins