安装

Mac 环境

首先安装 Homebrew。
安装 docker ，可通过 homebrew 安装 docker, 如果本地已经安装, 可以忽略此步骤。
因考虑有同学之前已有未通过 homebrew 安装的docker, 所以未使用 brew depend_on。

brew cask install docker

强烈建议用 cask 安装 docker 来安装 docker desktop for mac ，或下载安装。docker desktop 带 GUI 和 docker-compose 。否则需要自行安装 docker-compose 。

安装 Trantor CLI

brew tap TerminusHQ/trantor
brew install trantor

在 Terminal 中运行 CLI , 看是否正常

trantor version

配置 Host, mac 下暂时不会添加 host, 需自行添加

127.0.0.1 trantor.terminus.io

Windows 环境

(可选) 自行根据 windows 版本安装 docker（注意新版需要手动安装 docker machine）和 docker compose.
访问 https://terminus-trantor.oss-cn-hangzhou.aliyuncs.com/cli/trantor-cli.latest.tar.gz 下载工具
解压到合适的文件夹
运行文件夹内的 setup.cmd, 该命令会这是一些环境变量
在 CMD 中运行 CLI , 看是否正常

trantor version

Linux 环境

确保当前系统环境已安装curl
确保当前系统环境已安装 docker 以及 docker-compose
安装Trantor Cli

sudo curl -L https://terminus-trantor.oss-cn-hangzhou.aliyuncs.com/cli/install.sh | sh

在 Terminal 中运行 CLI , 看是否正常

trantor version

在/etc/hosts中添加追加以下Host

127.0.0.1 trantor.terminus.io

升级和卸载

升级

MacOS 下执行:

$brew upgrade trantor

卸载

MacOS 下执行:

$brew untap TerminusHQ/trantor
$brew uninstall trantor

命令

run

通过 Trantor CLI 启动本地环境, 第一次启动会拉镜像, 所以会有些慢, 耐心等待。

trantor run [version]

示例：

trantor run 0.15

⚠️注意：如果启动很慢, 或者访问很慢的话, 可以考虑调整 docker 宿主机的资源大小, 最好分配机器一半的核心和内存。保证 docker 有 4G 2C 以上的资源。

version

查看trantor版本

trantor version

stop

停止trantor应用。

trantor stop

restart

重启trantor应用

trantor restart

env

获取启动业务应用时需要配置一些环境变量。

trantor env

config

查看以及修改cli配置。

trantor config

watch

在本地开发时，可能会频繁修改View和Action文件，因此Trantor提供热加载View和Action，具体操作如下：

运行 trantor config 命令, 编辑打开的 json 文件

{
  "configVersion": 0,
  "runtimeRunningVersion": "latest",
  "env": {
    "ucMock": true,
    "aclMock": true,
    "dsPort": 8081,
    "msPort": 8082,
    "nacosPort": 8848,
    "dsDubboPort": 20891,
    "zkPort": 2182,
    "projectId": "trantor"
  },
  "watchingPaths": {}
}

在 watchingPaths 中加入开发模块的path，以 meta_store 模块为例

  "watchingPaths": {
  "meta_store": "/data/workspace/eto/meta-store/module-runtime/src/main/resources/trantor/resources"
  }

保存并退出编辑。

运行 trantor watch 命令

proxy

轻量化底座实际上就是对本地代理 tlp 的封装，使用 cli 快速启动 tlp ，详情请参考这里：Trantor本地代理(trantor local proxy) 。

clean

清理trantor数据。

trantor clean [target] [backup]

target 属性

target值名称	说明
db	数据库
config	配置信息
all	数据库和配置信息

backup属性

—backup

表示备份名称。

示例一：删除数据库

trantor clean db

示例二：删除数据库和配置config文件

trantor clean all

示例三：删除数据库同时备份数据库

trantor clean db  --backup

logs

查看日志。

trantor logs [OPTIONS] [component]

示例一：查看DS日志

trantor logs --follow  ds

示例二：查看MS日志

trantor logs --follow  ms

backup

from 0.17.12 。将当前数据库内容或者配置文件按给定 tag 备份。

> trantor backup -h
Usage: trantor backup [OPTIONS] target

  备份 Trantor 底座内容

Options:
  -t, --tag TEXT  备份 Tag ，当不指定时为当前 version
  -h, --help      Show this message and exit

Arguments:
  target  database 备份数据库；config 备份配置文件；all 备份上述两个

restore

from 0.17.12 。按 tag 将之前备份的内容恢复到工作位置。结合 backup 命令，可以适用于三种场景：

本地需要切换跑不同版本的 Trantor 底座。在每次切换版本之前 backup & restore 来避免数据结构兼容性的问题。
本地需要跑不同项目。通过 backup & restore 来切换项目元数据和数据。
将自己的数据共享给别人，或在组内准备一个完成了元数据上报和表初始化的原始数据。通过 backup 并将内容发送给别人来 restore 的方式。

❯ trantor restore -h
Usage: trantor restore [OPTIONS] target

  恢复备份的 Trantor 底座内容

Options:
  -t, --tag TEXT  恢复的目标 Tag
  -h, --help      Show this message and exit

Arguments:
  target  database 恢复数据库；config 恢复配置文件；all 恢复上述两个