Skip to content

deploy-cli ​

deploy 是轻量命令式 CI/CD 平台(deploy-server)的命令行客户端:Go 1.24+ 编写的单二进制,无运行时依赖。命令行框架为 spf13/cobra,实时日志基于 gorilla/websocket。它严格实现服务端 v1 冻结契约:Base path /api/v1、响应封装 {success,data,errorCode,errorMessage,showType}、请求头 Authorization: <裸 token>。

本章按使用场景拆成 7 页,从安装配置到输出约定,覆盖全部命令组。

命令组总览 ​

命令组用途详情
server管理本地服务器列表(名字 + 地址 + token)安装与服务器管理
login / logout / whoami登录、登出与身份确认登录与身份
project项目的增删改查与归档(构建 + 部署)项目命令
task一次性作业的创建、更新、预览与执行任务命令
run / logs / runs / stop触发运行、跟随日志、历史查询与取消运行与日志
middlewaredocker / postgresql / mysql / redis / elasticsearch 的安装与启停中间件命令
config / doctor / version低层配置读写、服务端环境自检、版本信息输出约定与退出码

各页导读 ​

  • 01 安装与服务器管理:构建与交叉编译、~/.deploy/config.yaml、server 命令组全示例、地址与 token 的优先级。
  • 02 登录与身份:交互与非交互登录、API Token 直写、JWT 与 dk_ Token 的取舍、token 打码约定。
  • 03 项目命令:flag / 向导 / --file 三种创建方式、Git 准备阶段、update 的字段保留语义、归档。
  • 04 任务命令:步骤整体保存、位置序号稳定的步骤 ID、--step-id 选择性执行、preview。
  • 05 运行与日志:run / logs / runs / stop,运行 ID 与构建号的区别,JSONL 跟随,Ctrl+C 与断线重连语义。
  • 06 中间件命令:安装预演与实装、启停与移除、参数设置与密码加密。
  • 07 输出约定与退出码:--json 的 stdout/stderr 分工、ANSI 剥离、退出码 0/1/2/3/4、doctor / config / version。

对 AI 与脚本友好 ​

这里没有给 AI 专用的子命令:AI 用的就是普通 deploy。两条约定让脚本与 Agent 可以完全非交互地操作:

  • --help 即命令清单:deploy --help 列出全部子命令,deploy <命令> --help 给出该命令的参数与示例。
  • --json 即机器接口:stdout 只输出 JSON / JSONL 数据,所有提示、警告、错误一律走 stderr;配合退出码 0/1/2/3/4 即可判断成败(见 07)。
bash
deploy --help                # 全部子命令
deploy run --help            # 某个子命令的参数
deploy server list --json    # 已配置的服务器
deploy whoami                # 当前服务器与用户(退出码 3=鉴权失败、4=不可达)
deploy doctor --json         # 服务端环境自检

交互与非交互等价:login(-p / --token)、project create(全部 --flag)都能在无 TTY 环境完成;需要确认的删除类操作在非交互环境必须显式 --yes。

相关章节 ​