npm package: @magecom/magecom-cli
Description: Magecom CLI: toolkit application.
Author: Grom Stanislav
Latest version: 1.0.16-auto-publish-6

# Installation

## System requirements:
1. Install node version manager (https://github.com/nvm-sh/nvm)
2. Run: `nvm install 20`
3. Run: `nvm use 20`

## Tool Installation
1. `nvm use 20`
2. `npm install -g @magecom/magecom-cli`
3. Test installation `mm config:show`

## User guide
Go to [User Guide](docs/USERGUIDE.md) for usage examples

## Developer
For Additional information see [Developer Guide](docs/DEVELOPERGUIDE.md)

## Usage:
1. mm [YOUR_COMMAND]

```
# Commands
<!-- commands -->
* [`mm config get KEY`](#mm-config-get-key)
* [`mm config set KEY VALUE`](#mm-config-set-key-value)
* [`mm config show`](#mm-config-show)
* [`mm env delete`](#mm-env-delete)
* [`mm env install`](#mm-env-install)
* [`mm env refresh`](#mm-env-refresh)
* [`mm env start`](#mm-env-start)
* [`mm env stop`](#mm-env-stop)
* [`mm env update CONTAINER`](#mm-env-update-container)
* [`mm help [COMMANDS]`](#mm-help-commands)
* [`mm m2 create`](#mm-m2-create)
* [`mm m2 init`](#mm-m2-init)
* [`mm m2 install`](#mm-m2-install)
* [`mm m2 uninstall`](#mm-m2-uninstall)
* [`mm m2 update`](#mm-m2-update)
* [`mm m2 upload-db DB-NAME`](#mm-m2-upload-db-db-name)
* [`mm office upload FILE`](#mm-office-upload-file)
* [`mm plugins`](#mm-plugins)
* [`mm plugins:install PLUGIN...`](#mm-pluginsinstall-plugin)
* [`mm plugins:inspect PLUGIN...`](#mm-pluginsinspect-plugin)
* [`mm plugins:install PLUGIN...`](#mm-pluginsinstall-plugin-1)
* [`mm plugins:link PLUGIN`](#mm-pluginslink-plugin)
* [`mm plugins:uninstall PLUGIN...`](#mm-pluginsuninstall-plugin)
* [`mm plugins:uninstall PLUGIN...`](#mm-pluginsuninstall-plugin-1)
* [`mm plugins:uninstall PLUGIN...`](#mm-pluginsuninstall-plugin-2)
* [`mm plugins update`](#mm-plugins-update)

## `mm config get KEY`

```
USAGE
  $ mm config get KEY [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  config:get KEY
```

## `mm config set KEY VALUE`

```
USAGE
  $ mm config set KEY VALUE [--v] [--vv] [--vvv] [-n] [--quiet] [--global] [--local]

FLAGS
  -n, --no-interaction
  --global              Set value to global-env
  --local               Set value to local-env
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  config:set KEY value [--global | --local]
```

## `mm config show`

```
USAGE
  $ mm config show [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  config:show
```

## `mm env delete`

```
USAGE
  $ mm env delete [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  env:delete
```

## `mm env install`

```
USAGE
  $ mm env install [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  env:install
```

## `mm env refresh`

```
USAGE
  $ mm env refresh [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  env:refresh
```

## `mm env start`

```
USAGE
  $ mm env start [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  env:start
```

## `mm env stop`

```
USAGE
  $ mm env stop [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  env:stop
```

## `mm env update CONTAINER`

```
USAGE
  $ mm env update CONTAINER [--v] [--vv] [--vvv] [-n] [--quiet]

ARGUMENTS
  CONTAINER  Container to update

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  env:update
```

## `mm help [COMMANDS]`

Display help for mm.

```
USAGE
  $ mm 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 mm.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_

## `mm m2 create`

```
USAGE
  $ mm m2 create -p <value> [--v] [--vv] [--vvv] [-n] [--quiet] [-s <value>] [-v <value>] [-c <value>] [-d]

FLAGS
  -c, --container=<value>        Php Container Version
  -d, --sample-data
  -n, --no-interaction
  -p, --project=<value>          (required) Project name
  -s, --search-engine=<value>    Search Engine
  -v, --magento-version=<value>  Magento Version
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  create -p=PROJECT_NAME
```

## `mm m2 init`

```
USAGE
  $ mm m2 init [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  init
```

## `mm m2 install`

```
USAGE
  $ mm m2 install [--v] [--vv] [--vvv] [-n] [--quiet] [-d <value>]

FLAGS
  -d, --db-dump-name=<value>  Office App database name to import
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  m2:install]
```

## `mm m2 uninstall`

```
USAGE
  $ mm m2 uninstall [--v] [--vv] [--vvv] [-n] [--quiet]

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  m2:uninstall
```

## `mm m2 update`

```
USAGE
  $ mm m2 update [--v] [--vv] [--vvv] [-n] [--quiet] [-d <value>]

FLAGS
  -d, --db-dump-name=<value>  Office App database name to import
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  m2:update
```

## `mm m2 upload-db DB-NAME`

```
USAGE
  $ mm m2 upload-db DB-NAME [--v] [--vv] [--vvv] [-n] [--quiet]

ARGUMENTS
  DB-NAME  Office db name

FLAGS
  -n, --no-interaction
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  m2:upload-db [db-name.sql]
```

## `mm office upload FILE`

```
USAGE
  $ mm office upload FILE [--v] [--vv] [--vvv] [-n] [--quiet] [-p <value>] [-k <value>] [-s <value>]

ARGUMENTS
  FILE  Path to file

FLAGS
  -k, --auth-key=<value>       Office auth keys
  -n, --no-interaction
  -p, --project-code=<value>   Project code in Office
  -s, --remote-source=<value>  Office remote source
  --quiet
  --v
  --vv
  --vvv

EXAMPLES
  office:upload [PATH_TO_FILE]
```

## `mm plugins`

List installed plugins.

```
USAGE
  $ mm plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ mm plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.4/src/commands/plugins/index.ts)_

## `mm plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ mm 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
  $ mm plugins add

EXAMPLES
  $ mm plugins:install myplugin 

  $ mm plugins:install https://github.com/someuser/someplugin

  $ mm plugins:install someuser/someplugin
```

## `mm plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ mm 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
  $ mm plugins:inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.4/src/commands/plugins/inspect.ts)_

## `mm plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ mm 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
  $ mm plugins add

EXAMPLES
  $ mm plugins:install myplugin 

  $ mm plugins:install https://github.com/someuser/someplugin

  $ mm plugins:install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.4/src/commands/plugins/install.ts)_

## `mm plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
  $ mm 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
  $ mm plugins:link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.4/src/commands/plugins/link.ts)_

## `mm plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ mm plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mm plugins unlink
  $ mm plugins remove
```

## `mm plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ mm plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mm plugins unlink
  $ mm plugins remove
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.4/src/commands/plugins/uninstall.ts)_

## `mm plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ mm plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mm plugins unlink
  $ mm plugins remove
```

## `mm plugins update`

Update installed plugins.

```
USAGE
  $ mm 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.9.4/src/commands/plugins/update.ts)_
<!-- commandsstop -->