upscale-cli
v0.0.6
Published
CLI for Upslcae
Downloads
3
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g upscale-cli
$ upscale COMMAND
running command...
$ upscale (--version)
upscale-cli/0.0.6 darwin-arm64 node-v18.18.2
$ upscale --help [COMMAND]
USAGE
$ upscale COMMAND
...
Commands
upscale dev
upscale hello PERSON
upscale hello world
upscale help [COMMANDS]
upscale init
upscale plugins
upscale plugins:install PLUGIN...
upscale plugins:inspect PLUGIN...
upscale plugins:install PLUGIN...
upscale plugins:link PLUGIN
upscale plugins:uninstall PLUGIN...
upscale plugins reset
upscale plugins:uninstall PLUGIN...
upscale plugins:uninstall PLUGIN...
upscale plugins update
upscale dev
describe the command here
USAGE
$ upscale dev [-f] [-n <value>]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ upscale dev
See code: src/commands/dev.ts
upscale hello PERSON
Say hello
USAGE
$ upscale 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: src/commands/hello/index.ts
upscale hello world
Say hello world
USAGE
$ upscale hello world
DESCRIPTION
Say hello world
EXAMPLES
$ upscale hello world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/hello/world.ts
upscale help [COMMANDS]
Display help for upscale.
USAGE
$ upscale 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 upscale.
See code: @oclif/plugin-help
upscale init
describe the command here
USAGE
$ upscale init [-f] [-n <value>]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ upscale init
See code: src/commands/init.ts
upscale plugins
List installed plugins.
USAGE
$ upscale plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ upscale plugins
See code: @oclif/plugin-plugins
upscale plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ upscale plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
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
$ upscale plugins add
EXAMPLES
$ upscale plugins:install myplugin
$ upscale plugins:install https://github.com/someuser/someplugin
$ upscale plugins:install someuser/someplugin
upscale plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ upscale 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
$ upscale plugins:inspect myplugin
See code: @oclif/plugin-plugins
upscale plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ upscale plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-s, --silent Silences yarn output.
-v, --verbose Show verbose yarn output.
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
$ upscale plugins add
EXAMPLES
$ upscale plugins:install myplugin
$ upscale plugins:install https://github.com/someuser/someplugin
$ upscale plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
upscale plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ upscale plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
$ upscale plugins:link myplugin
See code: @oclif/plugin-plugins
upscale plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ upscale plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ upscale plugins unlink
$ upscale plugins remove
upscale plugins reset
Remove all user-installed and linked plugins.
USAGE
$ upscale plugins reset
See code: @oclif/plugin-plugins
upscale plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ upscale plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ upscale plugins unlink
$ upscale plugins remove
See code: @oclif/plugin-plugins
upscale plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ upscale plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ upscale plugins unlink
$ upscale plugins remove
upscale plugins update
Update installed plugins.
USAGE
$ upscale plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins