ZStack UI CLI
npm install @zstackui/clioclif-hello-world
=================
oclif example Hello World CLI
* Usage
* Commands
* dev example
sh-session
$ npm install -g @zstackui/cli
$ zstack-ui-cli COMMAND
running command...
$ zstack-ui-cli (--version)
@zstackui/cli/1.0.4 darwin-arm64 node-v22.12.0
$ zstack-ui-cli --help [COMMAND]
USAGE
$ zstack-ui-cli COMMAND
...
`
Commands
*
*
* [](#zstack-ui-cli-configset-projectname-projectpath-branchname-env-specs-i18npath)
* zstack-ui-cli export:auth
*
*
* [](#zstack-ui-cli-help-command)
* zstack-ui-cli i18n:unique
*
*
*
*
*
*
*
*
*
*
*
* [](#zstack-ui-cli-sync-projectname-projectpath-branchname-env-specs-scripttype-i18npath-authpath-authdigestpath-enginepath)zstack-ui-cli config:clearClear ZStack UI CLI Global Config
USAGE
$ zstack-ui-cli config:clearDESCRIPTION
Clear ZStack UI CLI Global Config
EXAMPLES
$ zstack-ui-cli config clear
_See code: dist/commands/config/clear.ts_
Get ZStack UI CLI Global Config
USAGE
$ zstack-ui-cli config:getDESCRIPTION
Get ZStack UI CLI Global Config
EXAMPLES
$ zstack-ui-cli config get
_See code: dist/commands/config/get.ts_
Set ZStack UI CLI Global Config
USAGE
$ zstack-ui-cli config:set [PROJECTNAME] [PROJECTPATH] [BRANCHNAME] [ENV] [SPECS] [I18NPATH]ARGUMENTS
PROJECTNAME 项目名称，如zstack,zstone
PROJECTPATH [default: ./] 项目名称，如zstack,zstone
BRANCHNAME [default: master] 分支名称, 默认为master
ENV (dev|prod) [default: dev] 脚本运行环境, 默认为prod
SPECS 导入资源类型, 可输入i18n, buildAction, buildColumn, buildQuery, buildConstant, buildGlobalConfig,
buildTemplateConfig, all
I18NPATH [default: ./main/src/locales/] 相对项目根目录的导入I18n配置文件位置
DESCRIPTION
Set ZStack UI CLI Global Config
EXAMPLES
$ zstack-ui-cli config set zstone /root/zstone-ui 4.2.1 dev i18n,buildAction ./main.src/locales/
_See code: dist/commands/config/set.ts_
Export auth to ZStack-Assistant
USAGE
$ zstack-ui-cli export:authDESCRIPTION
Export auth to ZStack-Assistant
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
_See code: dist/commands/export/auth.ts_
Export column action to ZStack-Assistant
USAGE
$ zstack-ui-cli export:configDESCRIPTION
Export column action to ZStack-Assistant
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
_See code: dist/commands/export/config.ts_
Export i18n to ZStack-Assistant
USAGE
$ zstack-ui-cli export:i18nDESCRIPTION
Export i18n to ZStack-Assistant
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
_See code: dist/commands/export/i18n.ts_
Display help for zstack-ui-cli.
USAGE
$ zstack-ui-cli 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 zstack-ui-cli.
_See code: @oclif/plugin-help_
Export i18n to ZStack-Assistant
USAGE
$ zstack-ui-cli i18n:uniqueDESCRIPTION
Export i18n to ZStack-Assistant
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
_See code: dist/commands/i18n/unique.ts_
Import config from ZStack-Assistant and generate code in engine
USAGE
$ zstack-ui-cli importDESCRIPTION
Import config from ZStack-Assistant and generate code in engine
EXAMPLES
$ zstack-ui-cli import
_See code: dist/commands/import/index.ts_
Import config from ZStack-Assistant and generate code in engine
USAGE
$ zstack-ui-cli new:sub-appDESCRIPTION
Import config from ZStack-Assistant and generate code in engine
EXAMPLES
$ zstack-ui-cli new sub-app
_See code: dist/commands/new/sub-app/index.ts_
List installed plugins.
USAGE
$ zstack-ui-cli plugins [--core]FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ zstack-ui-cli plugins
_See code: @oclif/plugin-plugins_
Installs a plugin into the CLI.
USAGE
$ zstack-ui-cli 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
$ zstack-ui-cli plugins:add
EXAMPLES
$ zstack-ui-cli plugins:install myplugin
$ zstack-ui-cli plugins:install https://github.com/someuser/someplugin
$ zstack-ui-cli plugins:install someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ zstack-ui-cli plugins:inspect PLUGIN...ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ zstack-ui-cli plugins:inspect myplugin
_See code: @oclif/plugin-plugins_
Installs a plugin into the CLI.
USAGE
$ zstack-ui-cli 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
$ zstack-ui-cli plugins:add
EXAMPLES
$ zstack-ui-cli plugins:install myplugin
$ zstack-ui-cli plugins:install https://github.com/someuser/someplugin
$ zstack-ui-cli plugins:install someuser/someplugin
_See code: @oclif/plugin-plugins_
Links a plugin into the CLI for development.
USAGE
$ zstack-ui-cli plugins:link PLUGINARGUMENTS
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
$ zstack-ui-cli plugins:link myplugin
_See code: @oclif/plugin-plugins_
Removes a plugin from the CLI.
USAGE
$ zstack-ui-cli plugins:uninstall PLUGIN...ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ zstack-ui-cli plugins:unlink
$ zstack-ui-cli plugins:remove
Removes a plugin from the CLI.
USAGE
$ zstack-ui-cli plugins:uninstall PLUGIN...ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ zstack-ui-cli plugins:unlink
$ zstack-ui-cli plugins:remove
_See code: @oclif/plugin-plugins_
Removes a plugin from the CLI.
USAGE
$ zstack-ui-cli plugins:uninstall PLUGIN...ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ zstack-ui-cli plugins:unlink
$ zstack-ui-cli plugins:remove
Update installed plugins.
USAGE
$ zstack-ui-cli plugins:update [-h] [-v]FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
_See code: @oclif/plugin-plugins_
Import Config from ZStack-Assistant
USAGE
$ zstack-ui-cli sync [PROJECTNAME] [PROJECTPATH] [BRANCHNAME] [ENV] [SPECS] [SCRIPTTYPE] [I18NPATH]
[AUTHPATH] [AUTHDIGESTPATH] [ENGINEPATH]ARGUMENTS
PROJECTNAME 项目名称，如zstack,zstone
PROJECTPATH 项目名称，如zstack,zstone
BRANCHNAME [default: master] 分支名称, 默认为master
ENV (dev|prod) 脚本运行环境, 默认为prod
SPECS 导入资源类型, 可输入i18n, buildAction, buildColumn, buildQuery, buildConstant, buildGlobalConfig,
buildTemplateConfig, all
SCRIPTTYPE (ui|server) [default: ui] 相对项目根目录的导入I18n配置文件位置
I18NPATH [default: ./main/src/locales/] 相对项目根目录的导入I18n配置文件位置
AUTHPATH [default: ./main/public/auth/] 相对项目根目录的导入auth配置文件位置
AUTHDIGESTPATH [default: ./main/src/config/] 相对项目根目录的生成auth-digest配置文件位置
ENGINEPATH [default: ./engine/src] 相对项目根目录的engine代码位置
DESCRIPTION
Import Config from ZStack-Assistant
EXAMPLES
$ zstack-ui-cli sync zstone /root/zstone-ui/ master dev buildAction ./main/src/locales
_See code: dist/commands/sync/index.ts_
dev example
./bin/dev sync cloud /xxx/zstack-ui-next 5.4.0 dev i18n,buildAuth ui ./packages/apps/core-shell/public/i18n/ ../zstack-ui-next/packages/bff/src/auth/ ../zstack-ui-next/packages/apps/core-shell/src/config