xcart/xcart-tools

允许您从CLI执行各种开发操作,例如重新部署X-Cart。通过`composer global require xcart/xcart-tools`命令安装

v1.3.17 2022-03-15 13:02 UTC

README

允许您从CLI执行各种开发操作。当前命令列表如下

  • admin - 使用X-Cart数据库连接创建管理员配置文件
  • config - 通过提问创建X-Cart配置
  • deploy - 从不同的来源部署X-Cart。可用的来源有repo、最新版本和外部服务器。
  • doctor - 检查并修复X-Cart 5商店
  • dump - 创建数据库转储。可以在远程主机上运行。使用-m参数设置转储模式。
  • module - 创建新的空模块。可以在远程主机上运行。
  • pack - 通过指定的AuthorID-ModuleId名称创建模块包
  • product - 将产品实体生成到X-Cart数据库
  • redeploy - 重新创建X-Cart代码缓存并应用迁移\钩子
  • standUpload - [BETA] 上传X-Cart项目到stand。不适用于生产使用

全局命令参数

  • -s, --ssh_string[=SSH_STRING] - 用于命令的SSH用户@主机字符串
  • -P, --ssh_port[=SSH_PORT] - SSH端口 [默认: 22]

示例

更改工作目录到X-Cart安装或开发仓库,并运行

> php <path-to-tools>/tools.php <command>

# e.g.
> php <path-to-tools>/tools.php redeploy

远程命令执行

要通过SSH执行命令,您必须在远程服务器上拥有您的公钥,然后可以像示例中那样运行命令

> tools <command> -s remote_user@remote_host

例如,dump命令将在远程服务器上创建转储,然后自动将其下载到本地机器。

如何通过Composer全局安装

将以下行添加到您的~/.bash_profile脚本中

export PATH="$HOME/.composer/vendor/bin:$PATH"

然后简单地运行

> composer global require xcart/xcart-tools

之后,工具将在CLI中可用

> tools <command>

# e.g.
> tools redeploy

要查看每个命令的帮助,请运行

> tools <command> -h

#e.g.
> tools admin -h

命令描述和示例

admin

使用X-Cart数据库连接创建管理员配置文件。

支持通过SSH执行。

> tools admin

# with parameters
> tools admin -u admin@example.com -p master2356

# via SSH
> tools admin -u admin@example.com -p master2356 -s user@remote.com -P 22

# remove
> tools admin -u admin@example.com --remove=1

config

通过提问创建X-Cart配置。

支持通过SSH执行。

> tools config

# with parameters
> tools config -d my-store.com -w my_store

# via SSH
> tools config -s user@remote.com

deploy

从不同的来源部署X-Cart。可用的来源有repo、最新版本和外部服务器。命令会通过几个问题与用户交互

# deploy from latest or repo
> tools deploy

# deploy from remote server
> tools deploy -s user@remote.com

doctor

检查并修复X-Cart 5商店

目前唯一可用的操作是'clear_rebuild'。它会清除由崩溃的重建过程创建的所有临时文件。


> tools doctor

# with parameters
> tools doctor -m clear_rebuild

dump

创建数据库转储。可以在远程主机上运行。使用-m参数设置转储模式。

支持通过SSH执行。

> tools dump

# dump from remote server
> tools dump -s user@remote.com

module

创建新的空模块。可以在远程主机上运行。

命令会通过几个问题与用户交互

支持通过SSH执行。

> tools module

# create new module on remote server
> tools module -s user@remote.com

pack

通过指定的AuthorID-ModuleId名称创建模块包

> tools pack <AuthorId>-<ModuleId>

# e.g.
> tools pack Qualiteam-MyModule

product

将产品实体生成到X-Cart数据库

> tools product

> tools product -a 5

redeploy

重新创建X-Cart代码缓存并应用迁移\钩子

> tools redeploy