ubo-cli
v0.1.0
Published
Build & Publish Unified Back-Office Projects
Downloads
1
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g ubo-cli
$ ubo-cli COMMAND
running command...
$ ubo-cli (--version)
ubo-cli/0.0.0 darwin-arm64 node-v18.14.2
$ ubo-cli --help [COMMAND]
USAGE
$ ubo-cli COMMAND
...
Commands
ubo-cli hello PERSON
ubo-cli hello world
ubo-cli help [COMMANDS]
ubo-cli plugins
ubo-cli plugins:install PLUGIN...
ubo-cli plugins:inspect PLUGIN...
ubo-cli plugins:install PLUGIN...
ubo-cli plugins:link PLUGIN
ubo-cli plugins:uninstall PLUGIN...
ubo-cli plugins:uninstall PLUGIN...
ubo-cli plugins:uninstall PLUGIN...
ubo-cli plugins update
ubo-cli hello PERSON
Say hello
USAGE
$ ubo-cli 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: dist/commands/hello/index.ts
ubo-cli hello world
Say hello world
USAGE
$ ubo-cli hello world
DESCRIPTION
Say hello world
EXAMPLES
$ ubo-cli hello world
hello world! (./src/commands/hello/world.ts)
ubo-cli help [COMMANDS]
Display help for ubo-cli.
USAGE
$ ubo-cli 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 ubo-cli.
See code: @oclif/plugin-help
ubo-cli plugins
List installed plugins.
USAGE
$ ubo-cli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ubo-cli plugins
See code: @oclif/plugin-plugins
ubo-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ubo-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
$ ubo-cli plugins add
EXAMPLES
$ ubo-cli plugins:install myplugin
$ ubo-cli plugins:install https://github.com/someuser/someplugin
$ ubo-cli plugins:install someuser/someplugin
ubo-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ ubo-cli 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
$ ubo-cli plugins:inspect myplugin
ubo-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ubo-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
$ ubo-cli plugins add
EXAMPLES
$ ubo-cli plugins:install myplugin
$ ubo-cli plugins:install https://github.com/someuser/someplugin
$ ubo-cli plugins:install someuser/someplugin
ubo-cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ ubo-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
$ ubo-cli plugins:link myplugin
ubo-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ubo-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
$ ubo-cli plugins unlink
$ ubo-cli plugins remove
ubo-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ubo-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
$ ubo-cli plugins unlink
$ ubo-cli plugins remove
ubo-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ubo-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
$ ubo-cli plugins unlink
$ ubo-cli plugins remove
ubo-cli plugins update
Update installed plugins.
USAGE
$ ubo-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.