@umun-tech/umun-cli
v0.2.2
Published
CLI Tools to interact with Umun Framework.
Downloads
24
Readme
Umun CLI
CLI Tools for interfating with the Umun Framework.
Usage
$ npm install -g @umun-tech/umun-cli
$ umun COMMAND
running command...
$ umun (--version)
@umun-tech/umun-cli/0.2.2 darwin-x64 node-v14.17.0
$ umun --help [COMMAND]
USAGE
$ umun COMMAND
...
Commands
umun build [FILE]
umun entity [NAME]
umun help [COMMAND]
umun plugins
umun plugins:install PLUGIN...
umun plugins:inspect PLUGIN...
umun plugins:install PLUGIN...
umun plugins:link PLUGIN
umun plugins:uninstall PLUGIN...
umun plugins:uninstall PLUGIN...
umun plugins:uninstall PLUGIN...
umun plugins update
umun serve [FILE]
umun start [PROJECTNAME]
umun start blank [FILE]
umun start inq [FILE]
umun build [FILE]
describe the command here
USAGE
$ umun build [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ umun build
See code: dist/commands/build.ts
umun entity [NAME]
Interact with entities
USAGE
$ umun entity [NAME]
DESCRIPTION
Interact with entities
See code: dist/commands/entity.ts
umun help [COMMAND]
Display help for umun.
USAGE
$ umun 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 umun.
See code: @oclif/plugin-help
umun plugins
List installed plugins.
USAGE
$ umun plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ umun plugins
See code: @oclif/plugin-plugins
umun plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ umun 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
$ umun plugins add
EXAMPLES
$ umun plugins:install myplugin
$ umun plugins:install https://github.com/someuser/someplugin
$ umun plugins:install someuser/someplugin
umun plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ umun 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
$ umun plugins:inspect myplugin
umun plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ umun 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
$ umun plugins add
EXAMPLES
$ umun plugins:install myplugin
$ umun plugins:install https://github.com/someuser/someplugin
$ umun plugins:install someuser/someplugin
umun plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ umun 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
$ umun plugins:link myplugin
umun plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ umun plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ umun plugins unlink
$ umun plugins remove
umun plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ umun plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ umun plugins unlink
$ umun plugins remove
umun plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ umun plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ umun plugins unlink
$ umun plugins remove
umun plugins update
Update installed plugins.
USAGE
$ umun plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
umun serve [FILE]
describe the command here
USAGE
$ umun serve [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ umun serve
See code: dist/commands/serve.ts
umun start [PROJECTNAME]
describe the command here
USAGE
$ umun start [PROJECTNAME] [-p <value>] [-d <value>] [--db <value>] [--dbUser <value>] [--dbPass <value>]
[-l]
FLAGS
-d, --description=<value> Description of the project
-l, --latest Runs the latest code.. this is only for testing
-p, --packageName=<value> PackageName & GroupId of the projects
--db=<value> Name of the MySQL Database
--dbPass=<value> Password of the MySQL Database
--dbUser=<value> User name of the MySQL Database
DESCRIPTION
describe the command here
EXAMPLES
$ umun start
See code: dist/commands/start.ts
umun start blank [FILE]
describe the command here
USAGE
$ umun start blank [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ umun start blank
umun start inq [FILE]
describe the command here
USAGE
$ umun start inq [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ umun start inq