Skip to content

项目命令 ​

项目负责「构建 + 部署」:Git 准备阶段、按顺序执行的命令、依赖构建。项目的字段含义与生命周期见 项目定义;本页只讲 CLI 用法。触发运行见 运行与日志。

list:列出项目 ​

bash
deploy project list
deploy project list --keyword blog --page-size 100
deploy project list --archived          # 只看已归档的
flag默认说明
--keyword K空按关键字过滤
--page N1页码(从 1 起)
--page-size N50每页条数(最大 200)
--archivedfalse只列已归档项目;不传时按契约只列未归档项目

表格列出 KEY / 名称 / workdir / 最近运行时间 / 最近状态;ls 是 list 的别名。

get:项目详情 ​

bash
deploy project get my-app          # 基本信息 + 命令列表 + 环境变量
deploy project get my-app --json   # 字段名与 API 一致,可导出改后再建

命令表格里有 #(位置序号)与 ID(数据库 ID)两列:deploy run --command-id 用的是后者。项目的命令 ID 每次 update 会重新生成,所以 run --command-id 前必须重新 project get(对比任务的稳定步骤 ID,见 任务命令)。

create:三种创建方式 ​

flag 形式(非交互) ​

--command 可重复;'名称::脚本' 指定命令名,省略则自动命名为 step N:

bash
deploy project create \
  --key my-app --name "我的应用" --workdir /srv/workspaces/my-app \
  --command "git pull" \
  --command "依赖::npm ci" \
  --command "构建::npm run build" \
  --env MODE=prod --env DEBUG=0 \
  --shell auto --concurrency queue --timeout 1800 --fail-strategy abort

key 必须以字母或数字开头,只允许字母/数字/./-/_。非交互环境下 --key、--workdir 与至少一条命令必填。

交互式向导 ​

bash
deploy project create

在 TTY 下不带必需参数时自动进入向导,逐项提示 key / 名称 / workdir / 命令脚本;无 TTY 时不会进入向导,而是直接报用法错误。交互与非交互等价,CI 请用 flag 或 --file。

--file:JSON 项目定义 ​

Windows 上没有 bash 的 $(cat sh/01.sh):把项目定义写成 JSON,用 --file 读入,每条命令用 scriptFile 指向脚本文件:

json
{
  "key": "tio-boot-web-hello",
  "name": "tio-boot web hello",
  "workdir": "/srv/deploy/workspaces/tio-boot-web-hello",
  "useGit": true,
  "gitUrl": "https://gitee.com/ppnt/tio-boot-web-hello.git",
  "gitBranch": "main",
  "env": { "APP_PORT": "10062" },
  "commands": [
    { "name": "1. 环境勘察(只读)", "scriptFile": "sh/01-recon.sh" },
    { "name": "2. Maven 构建生产包", "scriptFile": "sh/02-build.sh" }
  ]
}
powershell
deploy project create --file project.json

文件方式的约定:

  • 字段名与 API 一致,deploy project get <key> --json 导出的内容改一改就能再建。
  • 每条命令内联 script 或给 scriptFile,二选一;两者都写会报错(退出码 2)。
  • scriptFile 相对 JSON 文件所在目录解析(sh\01.sh 这种 Windows 写法也行),读入后 CRLF 统一归一化为 LF。
  • 显式 flag 覆盖文件里的同名字段;--command 一旦传入则完全取代文件里的 commands(不是追加)。
  • 环境变量可写 envs 数组或 env 简写映射;同名时以 envs 为准。

Git 准备阶段 ​

flag默认说明
--use-gitfalse启用 Git 准备阶段(必须同时给 --git-url)
--git-url URL空仓库地址
--git-branch REFmain默认分支
--git-subdir DIR空仓库子目录
--git-depth N0浅克隆深度(0 = 完整克隆)
--git-cleanfalse拉取前清理工作目录
--git-submodulefalse递归拉取子模块
bash
deploy project create --key my-app --name my-app --workdir /srv/workspaces/my-app \
  --command "构建::npm run build" \
  --use-git --git-url git@host:org/repo.git --git-branch main \
  --git-subdir sub --git-depth 1 --git-clean --git-submodule

update:只改给出的字段 ​

bash
deploy project update my-app --file project.json   # 只改文件里给出的字段
deploy project update my-app --kind lib
deploy project update my-app --dependencies tio-boot-admin
deploy project update my-app --dependencies=       # 清空依赖
  • 未传的字段保持不变;文件里给出的 commands / envs 列表整体替换原列表。
  • 文件里的 key 若与目标项目不一致会报错;scriptFile 同样相对 JSON 目录解析。
  • update 的文件里环境变量必须用 envs 数组,不接受 env 简写(create 才接受简写)。
  • 命令 ID 会重新生成:之后要 run --command-id,先重新 project get 取新 ID。
  • --kind 只接受 app / lib;--dependencies 的每个 key 必须合法且不能指向自身。

库项目与依赖构建 ​

--kind lib 创建库项目,--dependencies 声明前置项目 key:

bash
deploy --server 97 project create --file library.json --kind lib --dependencies java-model
deploy --server 97 project update my-app --dependencies tio-boot-admin
deploy --server 97 run my-app --with-dependencies --wait --json

项目 JSON 同样接受 kind 与 dependencies 字段。依赖排序、环检测与失败传播由 deploy-server 处理;不加 --with-dependencies 时 run 只构建目标项目。

归档 ​

CLI 没有独立的 archive 子命令,但 update --file 会把文件里的字段原样透传给服务端更新接口,archived 也在其中(已核实 CLI 透传、服务端接受该字段):

bash
echo '{"archived":true}' > archive.json
deploy project update my-app --file archive.json    # 归档
echo '{"archived":false}' > archive.json
deploy project update my-app --file archive.json    # 取消归档

归档后的项目不能再触发运行,project list 默认也不再显示(用 --archived 查看)。Web UI 与 API 的归档入口见 项目归档。