用途:通过 CLI 管理 Dokploy 驱动的 VPS,覆盖项目、应用、compose 栈、域名和数据库的创建与运维,适合脚本化或智能体自动调用。
配置:先执行 vps config set --domain https://vps.crafter.run --api-key <KEY>。所有命令支持 --json 输出(走 stdout,日志走 stderr),-y/--yes 跳过确认;程序化调用建议 --json -y。
主要能力:
- 状态与项目:vps status --json;vps project list/create/info/remove。
- 应用:vps app list/create/info/deploy/redeploy/start/stop/remove。
- 域名:vps domain list/add/info/remove,默认 HTTPS + Let's Encrypt,可用 --no-https --cert none 关闭;支持 --port、--path、--strip-path、--service。
- Compose:vps compose list/info/deploy/redeploy/start/stop/env/services/remove,--delete-volumes 可删卷。
- GitHub 部署:vps github list/repos/branches;vps github deploy <owner/repo> -e <environmentId>,支持 --branch、--build-type(nixpacks 默认、dockerfile、heroku_buildpacks、paketo_buildpacks、static、railpack)、--dockerfile;加 --compose 部署为 compose,可配 --compose-path。
- 数据库:pg/mysql/mariadb/redis/mongo/libsql 各自的 create/list/info/deploy/start/stop/remove。create 自动生成密码并选可用端口,返回 connectionUrl 等字段。
典型用法:先创建项目并取 environmentId,再创建数据库或部署仓库;如需应用+数据库,可组合 use jq 解析 JSON 输出。
限制与注意:端口范围为 5433-5999,CLI 会检查已有数据库避免冲突;以 - 开头的 ID 需用 -- 分隔;Next.js/Node 在 compose 中须绑定 0.0.0.0 并设 HOSTNAME、PORT,否则 Traefik 返回 404;crafter.run 子域名需先建 DNS 记录再在 Dokploy 添加;多 GitHub 账号时需传 --github-id。其他收费、平台等信息暂未提供。