ssxcommitcli v1.0.0
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g ssxcuscommitcli
$ cus-cm COMMAND
running command...
$ cus-cm (--version)
ssxcuscommitcli/1.0.0 win32-x64 node-v12.20.0
$ cus-cm --help [COMMAND]
USAGE
$ cus-cm COMMAND
...$ npm install -g ssxcuscommitcli
$ cus-cm COMMAND
running command...
$ cus-cm (--version)
@cuscommit/cli/0.0.0 win32-x64 node-v14.18.0
$ cus-cm --help [COMMAND]
USAGE
$ cus-cm COMMAND
...$ npm install -g oclif-hello-world
$ oex COMMAND
running command...
$ oex (--version)
oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1
$ oex --help [COMMAND]
USAGE
$ oex COMMAND
...Commands
cus-cm commitcus-cm help [COMMAND]cus-cm pluginscus-cm plugins:install PLUGIN...cus-cm plugins:inspect PLUGIN...cus-cm plugins:install PLUGIN...cus-cm plugins:link PLUGINcus-cm plugins:uninstall PLUGIN...cus-cm plugins:uninstall PLUGIN...cus-cm plugins:uninstall PLUGIN...cus-cm plugins update
cus-cm commit
commit git message
USAGE
$ cus-cm commit
DESCRIPTION
commit git messagecus-cm help [COMMAND]
Display help for cus-cm.
USAGE
$ cus-cm 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 cus-cm.See code: @oclif/plugin-help
cus-cm plugins
List installed plugins.
USAGE
$ cus-cm plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ cus-cm pluginsSee code: @oclif/plugin-plugins
cus-cm plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ cus-cm 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
$ cus-cm plugins add
EXAMPLES
$ cus-cm plugins:install myplugin
$ cus-cm plugins:install https://github.com/someuser/someplugin
$ cus-cm plugins:install someuser/someplugincus-cm plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ cus-cm 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
$ cus-cm plugins:inspect myplugincus-cm plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ cus-cm 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
$ cus-cm plugins add
EXAMPLES
$ cus-cm plugins:install myplugin
$ cus-cm plugins:install https://github.com/someuser/someplugin
$ cus-cm plugins:install someuser/someplugincus-cm plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ cus-cm 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
$ cus-cm plugins:link myplugincus-cm plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cus-cm plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cus-cm plugins unlink
$ cus-cm plugins removecus-cm plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cus-cm plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cus-cm plugins unlink
$ cus-cm plugins removecus-cm plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cus-cm plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cus-cm plugins unlink
$ cus-cm plugins removecus-cm plugins update
Update installed plugins.
USAGE
$ cus-cm plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.cus-cm commitcus-cm help [COMMAND]cus-cm pluginscus-cm plugins:install PLUGIN...cus-cm plugins:inspect PLUGIN...cus-cm plugins:install PLUGIN...cus-cm plugins:link PLUGINcus-cm plugins:uninstall PLUGIN...cus-cm plugins:uninstall PLUGIN...cus-cm plugins:uninstall PLUGIN...cus-cm plugins update
cus-cm commit
commit git message
USAGE
$ cus-cm commit
DESCRIPTION
commit git messageSee code: dist/commands/commit.ts
cus-cm help [COMMAND]
Display help for cus-cm.
USAGE
$ cus-cm 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 cus-cm.See code: @oclif/plugin-help
cus-cm plugins
List installed plugins.
USAGE
$ cus-cm plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ cus-cm pluginsSee code: @oclif/plugin-plugins
cus-cm plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ cus-cm 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
$ cus-cm plugins add
EXAMPLES
$ cus-cm plugins:install myplugin
$ cus-cm plugins:install https://github.com/someuser/someplugin
$ cus-cm plugins:install someuser/someplugincus-cm plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ cus-cm 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
$ cus-cm plugins:inspect myplugincus-cm plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ cus-cm 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
$ cus-cm plugins add
EXAMPLES
$ cus-cm plugins:install myplugin
$ cus-cm plugins:install https://github.com/someuser/someplugin
$ cus-cm plugins:install someuser/someplugincus-cm plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ cus-cm 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
$ cus-cm plugins:link myplugincus-cm plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cus-cm plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cus-cm plugins unlink
$ cus-cm plugins removecus-cm plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cus-cm plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cus-cm plugins unlink
$ cus-cm plugins removecus-cm plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cus-cm plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cus-cm plugins unlink
$ cus-cm plugins removecus-cm plugins update
Update installed plugins.
USAGE
$ cus-cm plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.oex hello PERSONoex hello worldoex help [COMMAND]oex pluginsoex plugins:inspect PLUGIN...oex plugins:install PLUGIN...oex plugins:link PLUGINoex plugins:uninstall PLUGIN...oex plugins update
oex hello PERSON
Say hello
USAGE
$ oex hello [PERSON] -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Whom is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)See code: dist/commands/hello/index.ts
oex hello world
Say hello world
USAGE
$ oex hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oex hello world
hello world! (./src/commands/hello/world.ts)oex help [COMMAND]
Display help for oex.
USAGE
$ oex 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 oex.See code: @oclif/plugin-help
oex plugins
List installed plugins.
USAGE
$ oex plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ oex pluginsSee code: @oclif/plugin-plugins
oex plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ oex 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
$ oex plugins:inspect mypluginoex plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ oex 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
$ oex plugins add
EXAMPLES
$ oex plugins:install myplugin
$ oex plugins:install https://github.com/someuser/someplugin
$ oex plugins:install someuser/somepluginoex plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ oex 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
$ oex plugins:link mypluginoex plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ oex plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ oex plugins unlink
$ oex plugins removeoex plugins update
Update installed plugins.
USAGE
$ oex plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.4 years ago