Dokploy CLI

Overview

GitHubGitHub

Dokploy CLI 是一个用于远程管理 Dokploy 服务器的命令行工具。它基于 Dokploy 的 OpenAPI 规范自动生成，包含 449 条命令，覆盖了 Dokploy 的每一个 API 端点。 ## 主要能力 - **全面的命令覆盖**：提供 30 多个命令组，涵盖 application、postgres、mysql、mongo、redis、mariadb、compose、deployment、docker、domain、server、settings 等资源的管理操作。 - **多种认证方式**：支持通过 `auth` 命令直接配置 URL 和 API Key，也可以通过 Shell 环境变量（`DOKPLOY_URL`、`DOKPLOY_API_KEY`）或工作目录下的 `.env` 文件进行认证。Shell 环境变量的优先级高于 `.env` 文件。 - **结构化输出**：支持通过 `--json` 参数获取原始 JSON 格式的输出结果，便于与其他工具集成或在脚本中解析。 - **内置帮助系统**：可以通过 `dokploy --help` 查看所有命令组，使用 `dokploy <group> --help` 查看特定组内的操作，以及 `dokploy <group> <action> --help` 查看具体操作的参数选项。 ## 适用场景 该工具适合需要在终端环境中自动化或手动管理 Dokploy 实例的开发者和运维人员。无论是创建应用、部署服务、管理数据库（如启动或停止 Postgres 实例），还是配置域名与证书，都可以通过统一的 CLI 接口完成，无需频繁访问 Web 面板。 ## 开发与维护 项目使用 TypeScript 编写，采用 MIT 协议开源。命令由 `openapi.json` 自动生成，当 Dokploy 主仓库的 API 规范更新时，开发者可以替换本地的 `openapi.json` 并运行生成脚本以同步最新命令。

Q&A

如何安装 Dokploy CLI？AI-generated

可以通过 npm 全局安装：npm install -g @dokploy/cli。

CLI 的命令是如何生成的？AI-generated

所有命令都是根据 Dokploy 的 OpenAPI 规范（openapi.json）自动生成的，覆盖了每一个 API 端点。

如何进行身份认证？AI-generated

有三种方式：1. 使用 dokploy auth -u <URL> -t <API_KEY> 命令；2. 设置 DOKPLOY_URL 和 DOKPLOY_API_KEY 环境变量；3. 在工作目录创建包含这两个变量的 .env 文件。环境变量优先级高于 .env 文件。

如何获取 JSON 格式的输出？AI-generated

在执行命令时加上 --json 参数即可，例如 dokploy project all --json。

如何更新 CLI 中的命令？AI-generated

将最新的 openapi.json 放入项目，然后依次运行 pnpm run generate 和 pnpm run build 重新生成并构建命令。