Skip to content

任务命令 ​

项目负责「构建 + 部署」(Git 准备阶段、依赖构建);任务负责「跑一件事」:勘察、改配置、清缓存、导数据等。任务没有 Git、没有依赖,步骤就是按顺序跑的 shell。任务的字段含义见 任务定义。

list / get ​

bash
deploy task list                          # 表格:KEY / 名称 / workdir / 最近运行 / 状态
deploy task list --keyword recon --page-size 100
deploy task list --archived               # 只看已归档的
deploy task get clear-cache               # 详情 + 步骤表 + 环境变量
flag默认说明
--keyword K空按关键字过滤
--page N1页码(从 1 起)
--page-size N50每页条数(最大 200)
--archivedfalse只列已归档任务;不传时只列未归档任务

task get 的步骤表里标注了「ID = position, stable across updates」:步骤 ID 就是位置序号(1 起),也就是 task run --step-id 要的值。

create ​

bash
deploy task create --key clear-cache --name 清缓存 --workdir /srv/ops --step "redis-cli flushdb"
deploy task create --file task.json       # 步骤可内联 script 或给 scriptFile
  • --step 可重复;'名称::脚本' 指定步骤名,省略则自动命名为 step N。
  • --key 与 --workdir 必填(任务创建没有交互式向导),至少一个步骤。
  • 其余 flag 与项目一致:--env K=V、--shell auto|bash|sh|pwsh|cmd、--concurrency queue|allow|cancelPrev、--timeout N、--fail-strategy abort|continue、--hook=false、--allow-env-override=false。
  • --file 的 JSON 里步骤写 steps 数组,每步内联 script 或给 scriptFile(相对 JSON 文件目录,CRLF 归一化为 LF,两者都写报错);显式 flag 覆盖文件,--step 一旦传入则完全取代文件里的 steps。
json
{
  "key": "hula-recon",
  "name": "HuLa read-only recon",
  "workdir": "/srv/deploy/workspaces/hula-recon",
  "steps": [
    { "name": "frp config", "scriptFile": "sh/recon-frp.sh" }
  ]
}

update:步骤整体替换 ​

bash
deploy task update clear-cache --file task.json
  • update 只接受 --file:只改文件里给出的字段,未传字段保持不变。
  • 文件里带 steps 就整体替换全部步骤,没有单条步骤的 CRUD。
  • 文件里的 key 若与目标任务不一致会报错;环境变量必须用 envs 数组,不接受 env 简写。
  • 归档同样走透传:{"archived":true} 即可归档任务(服务端更新接口接受该字段)。

步骤 ID 与项目命令 ID 的关键差异 ​

任务步骤项目命令
ID 含义位置序号(1 起)数据库 ID
update 之后不变(仍是第几步)重新生成
选择性执行task run --step-id N,无需重新 getrun --command-id ID,必须先重新 project get

所以脚本里可以放心写死 --step-id 13;而项目的 --command-id 在每次 update 后都要重新取值。

run:触发任务 ​

bash
deploy task run clear-cache               # 立刻返回 runId
deploy task run clear-cache -f            # 先补历史日志,再实时跟随到结束
deploy task run clear-cache --wait        # 不打印日志,只等结果
deploy task run hula-recon --step-id 13 -f          # 只跑第 13 步
deploy task run hula-recon --step-id 2 --step-id 3  # 可重复,跑多步
deploy task run clear-cache -f -e SCOPE=all --cancel-on-interrupt
flag说明
-f, --follow先回放历史,再经 WebSocket 实时跟随到结束
--wait只等终态,不打印日志
-e K=V触发时覆盖环境变量(可重复)
--step-id N只跑指定位置序号的步骤(可重复,必须为正整数)
--cancel-on-interruptCtrl+C 时取消运行(默认只断开跟随)

任务没有 Git 与依赖,因此 task run 不接受 --branch 与 --with-dependencies:传入会被 cobra 当作未知 flag 拒绝,返回退出码 2。这两个 flag 只属于项目的 deploy run(见 运行与日志)。

preview:只展开不执行 ​

bash
deploy task preview clear-cache           # 展开成一段完整脚本预览
deploy task preview clear-cache -e SCOPE=all

preview 调服务端把步骤与环境变量展开成最终会执行的脚本并打印(stderr 提示 workdir,stdout 是脚本),不创建运行、不执行任何命令。适合在执行前人工审查,或让 AI 先确认脚本内容。

与项目共用运行体系 ​

任务与项目共用 Run 表、日志与 Hook:

bash
deploy logs 88 -f        # 跟随任务运行的日志
deploy runs list         # 历史运行(项目与任务都在里面)
deploy stop 88           # 幂等取消

退出码、Ctrl+C 与断线重连语义完全一致,详见 运行与日志 与 输出约定与退出码。