staroverlay-cli
v0.0.0
Published
A new CLI generated with oclif
Downloads
4
Readme
staroverlay-cli
A new CLI generated with oclif
Usage
$ npm install -g staroverlay-cli
$ so COMMAND
running command...
$ so (--version)
staroverlay-cli/0.0.0 win32-x64 node-v22.3.0
$ so --help [COMMAND]
USAGE
$ so COMMAND
...
Commands
so deploy [FILE]
so help [COMMAND]
so plugins
so plugins add PLUGIN
so plugins:inspect PLUGIN...
so plugins install PLUGIN
so plugins link PATH
so plugins remove [PLUGIN]
so plugins reset
so plugins uninstall [PLUGIN]
so plugins unlink [PLUGIN]
so plugins update
so deploy [FILE]
describe the command here
USAGE
$ so deploy [FILE] [-f] [-n <value>]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ so deploy
See code: src/commands/deploy.ts
so help [COMMAND]
Display help for so.
USAGE
$ so 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 so.
See code: @oclif/plugin-help
so plugins
List installed plugins.
USAGE
$ so plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ so plugins
See code: @oclif/plugin-plugins
so plugins add PLUGIN
Installs a plugin into so.
USAGE
$ so plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into so.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SO_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ so plugins add
EXAMPLES
Install a plugin from npm registry.
$ so plugins add myplugin
Install a plugin from a github url.
$ so plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ so plugins add someuser/someplugin
so plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ so 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
$ so plugins inspect myplugin
See code: @oclif/plugin-plugins
so plugins install PLUGIN
Installs a plugin into so.
USAGE
$ so plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into so.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SO_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ so plugins add
EXAMPLES
Install a plugin from npm registry.
$ so plugins install myplugin
Install a plugin from a github url.
$ so plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ so plugins install someuser/someplugin
See code: @oclif/plugin-plugins
so plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ so plugins link PATH [-h] [--install] [-v]
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
$ so plugins link myplugin
See code: @oclif/plugin-plugins
so plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ so plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ so plugins unlink
$ so plugins remove
EXAMPLES
$ so plugins remove myplugin
so plugins reset
Remove all user-installed and linked plugins.
USAGE
$ so plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
See code: @oclif/plugin-plugins
so plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ so plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ so plugins unlink
$ so plugins remove
EXAMPLES
$ so plugins uninstall myplugin
See code: @oclif/plugin-plugins
so plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ so plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ so plugins unlink
$ so plugins remove
EXAMPLES
$ so plugins unlink myplugin
so plugins update
Update installed plugins.
USAGE
$ so plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins