@miniserver/cli
v0.0.24
Published
Miniserver CLI
Downloads
10
Readme
miniserver
Miniserver Deployment CLI
Usage
$ npm install -g @miniserver/cli
$ miniserver COMMAND
running command...
$ miniserver (--version)
@miniserver/cli/0.0.23 darwin-arm64 node-v21.4.0
$ miniserver --help [COMMAND]
USAGE
$ miniserver COMMAND
...
Commands
miniserver deploy
miniserver help
miniserver login
miniserver logout
miniserver new-app
miniserver plugins
miniserver plugins:install PLUGIN...
miniserver plugins:inspect PLUGIN...
miniserver plugins:install PLUGIN...
miniserver plugins:link PLUGIN
miniserver plugins:uninstall PLUGIN...
miniserver plugins:uninstall PLUGIN...
miniserver plugins:uninstall PLUGIN...
miniserver plugins update
miniserver register
miniserver deploy
Deploy project to miniserver
USAGE
$ miniserver deploy [-b]
FLAGS
-b, --build Skip build project
DESCRIPTION
Deploy project to miniserver
EXAMPLES
$ miniserver deploy
See code: src/commands/deploy/index.ts
miniserver help
Helper
USAGE
$ miniserver help
DESCRIPTION
Helper
See code: src/commands/help.ts
miniserver login
Login to miniserver
USAGE
$ miniserver login
DESCRIPTION
Login to miniserver
See code: src/commands/login.ts
miniserver logout
Logout
USAGE
$ miniserver logout
DESCRIPTION
Logout
See code: src/commands/logout.ts
miniserver new-app
Create new app
USAGE
$ miniserver new-app
DESCRIPTION
Create new app
EXAMPLES
Create new app
See code: src/commands/new-app.ts
miniserver plugins
List installed plugins.
USAGE
$ miniserver plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ miniserver plugins
See code: @oclif/plugin-plugins
miniserver plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ miniserver 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
$ miniserver plugins add
EXAMPLES
$ miniserver plugins:install myplugin
$ miniserver plugins:install https://github.com/someuser/someplugin
$ miniserver plugins:install someuser/someplugin
miniserver plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ miniserver 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
$ miniserver plugins:inspect myplugin
See code: @oclif/plugin-plugins
miniserver plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ miniserver 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
$ miniserver plugins add
EXAMPLES
$ miniserver plugins:install myplugin
$ miniserver plugins:install https://github.com/someuser/someplugin
$ miniserver plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
miniserver plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ miniserver 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
$ miniserver plugins:link myplugin
See code: @oclif/plugin-plugins
miniserver plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ miniserver plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ miniserver plugins unlink
$ miniserver plugins remove
miniserver plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ miniserver plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ miniserver plugins unlink
$ miniserver plugins remove
See code: @oclif/plugin-plugins
miniserver plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ miniserver plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ miniserver plugins unlink
$ miniserver plugins remove
miniserver plugins update
Update installed plugins.
USAGE
$ miniserver plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
miniserver register
Register to miniserver
USAGE
$ miniserver register
DESCRIPTION
Register to miniserver
See code: src/commands/register.ts