@mci-fe/workbench-cli v1.17.0

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @mci-fe/workbench-cli
$ mci COMMAND
running command...
$ mci (--version)
@mci-fe/workbench-cli/1.17.0 darwin-arm64 node-v18.17.0
$ mci --help [COMMAND]
USAGE
  $ mci COMMAND
...

Commands

• mci <COMMAND>
• mci api clean
• mci api config
• mci api generate
• mci help [COMMAND]
• mci microapp add NAME
• mci page add [NAME]
• mci pipeline build
• mci plugins
• mci plugins add PLUGIN
• mci plugins:inspect PLUGIN...
• mci plugins install PLUGIN
• mci plugins link PATH
• mci plugins remove [PLUGIN]
• mci plugins reset
• mci plugins uninstall [PLUGIN]
• mci plugins unlink [PLUGIN]
• mci plugins update
• mci run dev
• mci run preview

mci <COMMAND>

Api 客户端请求代码生成命令的集合

USAGE
  $ mci api <COMMAND>

DESCRIPTION
  Api 客户端请求代码生成命令的集合

EXAMPLES
  $ mci api generate

See code: src/commands/api/index.ts

mci api clean

删除 api 目录中所有的生成文件（interceptors.ts 文件除外）

USAGE
  $ mci api clean [-f] [-d <value>]

FLAGS
  -d, --dir=<value>
  -f, --all

DESCRIPTION
  删除 api 目录中所有的生成文件（interceptors.ts 文件除外）

EXAMPLES
  $ mci api clean [-f] [-d=./src/api2]

See code: src/commands/api/clean.ts

mci api config

生成配置文件，并写入到 src/config/ 文件夹之下

USAGE
  $ mci api config

DESCRIPTION
  生成配置文件，并写入到 src/config/ 文件夹之下

EXAMPLES
  $ mci api config

See code: src/commands/api/config.ts

mci api generate

根据配置文件来生成所有的 api 请求客户端代码

USAGE
  $ mci api generate [-s <value>]

FLAGS
  -s, --server-name=<value>  Backend server name for client request

DESCRIPTION
  根据配置文件来生成所有的 api 请求客户端代码

EXAMPLES
  $ mci api generate

See code: src/commands/api/generate.ts

mci help [COMMAND]

Display help for mci.

USAGE
  $ mci 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 mci.

See code: @oclif/plugin-help

mci microapp add NAME

创建子应用

USAGE
  $ mci microapp add NAME -p <value> [-b]

ARGUMENTS
  NAME  name of microapp

FLAGS
  -b, --bootstrap     whether bootstrap the microapp's development server or not
  -p, --port=<value>  (required) port for the local develoment server

DESCRIPTION
  创建子应用

EXAMPLES
  $ mci microapp add app1

See code: src/commands/microapp/add.ts

mci page add [NAME]

Add a new page

USAGE
  $ mci page add [NAME] -p <value> -m <value> [-t <value>]

ARGUMENTS
  NAME  page name to generate

FLAGS
  -m, --devMode=<value>  (required) 页面开发模式
  -p, --path=<value>     (required) route path for this page
  -t, --text=<value>     chinese locale of page name

DESCRIPTION
  Add a new page

EXAMPLES
  $ mci page add

See code: src/commands/page/add.ts

mci pipeline build

流水线构建子应用

USAGE
  $ mci pipeline build [--appMode development|staging|uat|production] [--serverName
    dev1|dev2|dev3|dev4|stg1|stg2|stg3|stg4]

FLAGS
  --appMode=<option>     <options: development|staging|uat|production>
  --serverName=<option>  <options: dev1|dev2|dev3|dev4|stg1|stg2|stg3|stg4>

DESCRIPTION
  流水线构建子应用

EXAMPLES
  $ mci pipeline build

See code: src/commands/pipeline/build.ts

mci plugins

List installed plugins.

USAGE
  $ mci plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ mci plugins

See code: @oclif/plugin-plugins

mci plugins add PLUGIN

Installs a plugin into mci.

USAGE
  $ mci 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 mci.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the MCI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MCI_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ mci plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ mci plugins add myplugin

  Install a plugin from a github url.

    $ mci plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ mci plugins add someuser/someplugin

mci plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ mci 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
  $ mci plugins inspect myplugin

See code: @oclif/plugin-plugins

mci plugins install PLUGIN

Installs a plugin into mci.

USAGE
  $ mci 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 mci.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the MCI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the MCI_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ mci plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ mci plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ mci plugins install someuser/someplugin

See code: @oclif/plugin-plugins

mci plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ mci 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
  $ mci plugins link myplugin

See code: @oclif/plugin-plugins

mci plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ mci 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
  $ mci plugins unlink
  $ mci plugins remove

EXAMPLES
  $ mci plugins remove myplugin

mci plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ mci 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

mci plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ mci 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
  $ mci plugins unlink
  $ mci plugins remove

EXAMPLES
  $ mci plugins uninstall myplugin

See code: @oclif/plugin-plugins

mci plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ mci 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
  $ mci plugins unlink
  $ mci plugins remove

EXAMPLES
  $ mci plugins unlink myplugin

mci plugins update

Update installed plugins.

USAGE
  $ mci plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

mci run dev

启动子应用开发

USAGE
  $ mci run dev [--appMode development|staging|uat|production|remoteMock] [--serverName
    local|dev1|dev2|dev3|dev4|stg1|stg2|stg3|stg4|uat1]

FLAGS
  --appMode=<option>     <options: development|staging|uat|production|remoteMock>
  --serverName=<option>  <options: local|dev1|dev2|dev3|dev4|stg1|stg2|stg3|stg4|uat1>

DESCRIPTION
  启动子应用开发

EXAMPLES
  $ mci run dev

See code: src/commands/run/dev.ts

mci run preview

启动子应用开发

USAGE
  $ mci run preview [-p <value>]

FLAGS
  -p, --port=<value>

DESCRIPTION
  启动子应用开发

EXAMPLES
  $ mci run preview

See code: src/commands/run/preview.ts