# @dokploy/cli 中文文档

规范地址：https://npmcn.com/package/%40dokploy/cli/

版本：0\.30\.7
npm 元数据更新时间：2026-09-18T09:16:46.188Z
中文译文更新时间：2026-11-12T15:14:27.319Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dokploy/cli
原文对照：https://npmcn.com/package/%40dokploy/cli/?lang=original
项目主页：https://github.com/Dokploy/cli
源码仓库：https://github.com/Dokploy/cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：467 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：3 个
- 首次发布：2024-06-23T05:47:09.894Z
- 最新版本发布：2026-09-18T09:16:45.994Z
- 近 30 天下载量：6151（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 24 个）

## 中文简介

远程管理 dokploy 服务器的 CLI

## 安装

```sh
npm install @dokploy/cli
```

也可以使用：`pnpm add @dokploy/cli`、`yarn add @dokploy/cli`、`bun add @dokploy/cli`

## README

# Dokploy CLI (英语)

Dokploy CLI 是远程管理您 Dokploy 服务器的指令行工具 。 它规定 **449个命令** 从 Dokploy OpenAPI spec 自动生成,覆盖每个API 端点.

## 安装

```bash
npm install -g @dokploy/cli
```

## 认证

### 备选案文1: `auth` 命令

```bash
dokploy auth -u https://panel.dokploy.com -t YOUR_API_KEY
```

### 备选案文2:环境变量

```bash
export DOKPLOY_URL="https://panel.dokploy.com"
export DOKPLOY_API_KEY="YOUR_API_KEY"
```

### 备选案文3: `.env` 文件

创建一个 `.env` 在工作目录中的文件 :

```env
DOKPLOY_URL="https://panel.dokploy.com"
DOKPLOY_API_KEY="YOUR_API_KEY"
```

CLI自动加载. 贝壳环境变量优先于 `.env` 文档.

## 使用量

```bash
dokploy <group> <action> [options]
```

### 实例

```bash
# List all projects
dokploy project all

# Get a specific project
dokploy project one --projectId abc123

# Create an application
dokploy application create --name "my-app" --environmentId env123

# Deploy an application
dokploy application deploy --applicationId app123

# Create a postgres database
dokploy postgres create --name "my-db" --environmentId env123

# Stop a database
dokploy postgres stop --postgresId pg123

# Get raw JSON output
dokploy project all --json
```

### 获得帮助

```bash
# List all groups
dokploy --help

# List actions in a group
dokploy application --help

# See options for a specific action
dokploy application deploy --help
```

## 可用的指令组

| 组 | 图标 | 组 | 图标 |
| --- | --- | --- | --- |
| `admin` | 1个 | `notification` | 第38条 |
| `ai` | 第9条 | `organization` | 10个 |
| `application` | 29个 | `patch` | 第12条 |
| `backup` | 第11个 | `port` | 页:1 |
| `bitbucket` | 第7条 | `postgres` | 页:1 |
| `certificates` | 页:1 | `preview-deployment` | 页:1 |
| `cluster` | 页:1 | `project` | 第8条 |
| `compose` | 第28条 | `redirects` | 页:1 |
| `deployment` | 第8条 | `redis` | 页:1 |
| `destination` | 6个 | `registry` | 第7条 |
| `docker` | 第7条 | `rollback` | 2个 |
| `domain` | 第9条 | `schedule` | 6个 |
| `environment` | 第7条 | `security` | 页:1 |
| `gitea` | 第8条 | `server` | 16个 |
| `github` | 6个 | `settings` | 第49条 |
| `gitlab` | 第7条 | `ssh-key` | 6个 |
| `git-provider` | 2个 | `sso` | 10个 |
| `license-key` | 6个 | `stripe` | 第7条 |
| `mariadb` | 页:1 | `swarm` | 3个 |
| `mongo` | 页:1 | `user` | 第 18 条 |
| `mounts` | 6个 | `volume-backups` | 6个 |
| `mysql` | 页:1 |  |  |

## 发展

```bash
# Install dependencies
pnpm install

# Run in dev mode
pnpm run dev -- project all

# Regenerate commands from OpenAPI spec
pnpm run generate

# Build
pnpm run build

# Lint & format
pnpm run lint
```

### 更新命令

命令是自动生成的 `openapi.json`。更新:

1.  替换 `openapi.json` 带有来自 [Dokploy 重传](https://github.com/Dokploy/dokploy)
2.  运行 `pnpm run generate`
3.  以 `pnpm run build`

## 捐款

如果你想向Dokploy CLI捐款,请检查我们 [贡献指南](https://github.com/Dokploy/cli/blob/main/CONTRIBUTING.md)。 。 。 .

## 支助

如果你遇到任何问题或问题,请 [打开一个问题](https://github.com/Dokploy/cli/issues) 在我们的 GitHub 仓库中.

## 许可证

本项目根据以下规定获得许可证: [MIT 许可证](https://npmcn.com/package/%40dokploy/cli/LICENSE)。 。 。 .

## 常见问题

### @dokploy/cli 是什么？

远程管理 dokploy 服务器的 CLI

### 如何安装 @dokploy/cli？

在项目目录运行 npm install @dokploy/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 dokploy，可以用 npx dokploy 直接运行。

### @dokploy/cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dokploy/cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dokploy/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @dokploy/cli 可以商用吗？

@dokploy/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dokploy/cli 的下载量有多少？

根据 npm 官方下载统计，@dokploy/cli 在 2026/10/13 – 2026/11/11 这 30 天内被下载 6,151 次，日均约 205 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dokploy/cli 还在维护吗？

最新版本 0\.30\.7 发布于 2026/09/18（1 个月前）；至今共发布 30 个版本，其中过去 12 个月发布了 24 个；首次发布于 2024/06/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。