From 1ad5a4d4d639170174b95469232ce8f912cb61f0 Mon Sep 17 00:00:00 2001 From: tigerenwork Date: Sun, 9 Aug 2026 20:19:13 +0800 Subject: [PATCH] docs: complete prerequisite install instructions for sling and atlas --- README.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 27516b6..df13066 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,34 @@ ## 前置依赖 -- Node.js 20+ 与 pnpm -- `sling` CLI(`curl -LO 'https://github.com/slingdata-io/sling-cli/releases/latest/download/sling_darwin_arm64.tar.gz' ...`,见官方文档;需要官方构建,`conns discover` 在 OSS 自编译版不可用) -- `atlas` CLI:`brew install ariga/tap/atlas` +应用本身不内置迁移引擎,需要单独安装以下两个 CLI(启动后顶部 banner 会检测是否可用): -启动后应用会在顶部 banner 检测这两个二进制是否可用。 +- Node.js 20+ 与 pnpm +- **sling CLI**(数据迁移)。需要**官方构建**(`conns discover` 在 OSS 自编译版不可用): + + ```bash + # Mac / Linux 一行安装(装到 ~/.sling/bin,应用会自动探测该路径) + curl -fsSL https://slingdata.io/install.sh | bash + + # 或 Mac 用 brew + brew install slingdata-io/sling/sling + ``` + + 其他方式见 [sling 官方安装文档](https://docs.slingdata.io/sling-cli/getting-started)。 + +- **Atlas CLI**(schema 迁移,社区版即可): + + ```bash + # Mac + brew install ariga/tap/atlas + + # Linux + curl -sSf https://atlasgo.sh | sh + ``` + + 其他方式见 [Atlas 安装文档](https://atlasgo.io/getting-started#installation)。 + +不需要安装 docker 或 mysql 客户端:Atlas 的 dev database 复用目标服务器上的 scratch schema(`sling_ui_atlas_dev`),数据库连接全部走 sling/atlas 自带的驱动。 ## 启动