npm package: @miniserver/cli
Description: Miniserver CLI
Author: miniserver
Latest version: 0.0.24

miniserver
=================

Miniserver Deployment CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`miniserver deploy`](#miniserver-deploy)
* [`miniserver help`](#miniserver-help)
* [`miniserver login`](#miniserver-login)
* [`miniserver logout`](#miniserver-logout)
* [`miniserver new-app`](#miniserver-new-app)
* [`miniserver plugins`](#miniserver-plugins)
* [`miniserver plugins:install PLUGIN...`](#miniserver-pluginsinstall-plugin)
* [`miniserver plugins:inspect PLUGIN...`](#miniserver-pluginsinspect-plugin)
* [`miniserver plugins:install PLUGIN...`](#miniserver-pluginsinstall-plugin-1)
* [`miniserver plugins:link PLUGIN`](#miniserver-pluginslink-plugin)
* [`miniserver plugins:uninstall PLUGIN...`](#miniserver-pluginsuninstall-plugin)
* [`miniserver plugins:uninstall PLUGIN...`](#miniserver-pluginsuninstall-plugin-1)
* [`miniserver plugins:uninstall PLUGIN...`](#miniserver-pluginsuninstall-plugin-2)
* [`miniserver plugins update`](#miniserver-plugins-update)
* [`miniserver register`](#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](https://github.com/miniappx-cli/miniserver/blob/v0.0.23/src/commands/deploy/index.ts)_

## `miniserver help`

Helper

```
USAGE
  $ miniserver help

DESCRIPTION
  Helper
```

_See code: [src/commands/help.ts](https://github.com/miniappx-cli/miniserver/blob/v0.0.23/src/commands/help.ts)_

## `miniserver login`

Login to miniserver

```
USAGE
  $ miniserver login

DESCRIPTION
  Login to miniserver
```

_See code: [src/commands/login.ts](https://github.com/miniappx-cli/miniserver/blob/v0.0.23/src/commands/login.ts)_

## `miniserver logout`

Logout

```
USAGE
  $ miniserver logout

DESCRIPTION
  Logout
```

_See code: [src/commands/logout.ts](https://github.com/miniappx-cli/miniserver/blob/v0.0.23/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](https://github.com/miniappx-cli/miniserver/blob/v0.0.23/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](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/index.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/inspect.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/install.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/link.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/uninstall.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v3.7.0/src/commands/plugins/update.ts)_

## `miniserver register`

Register to miniserver

```
USAGE
  $ miniserver register

DESCRIPTION
  Register to miniserver
```

_See code: [src/commands/register.ts](https://github.com/miniappx-cli/miniserver/blob/v0.0.23/src/commands/register.ts)_
<!-- commandsstop -->