# @dokploy/sdk 中文文档

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

版本：0\.30\.7
npm 元数据更新时间：2026-09-18T09:21:52.469Z
中文译文更新时间：2026-11-12T15:18:10.433Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40dokploy/sdk
原文对照：https://npmcn.com/package/%40dokploy/sdk/?lang=original

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

- 包体积（解压后）：1.9 MB，67 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-05-11T18:55:34.067Z
- 最新版本发布：2026-09-18T09:21:52.097Z
- 近 30 天下载量：4321（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 21 个）

## 中文简介

Dokploy API 的脚本 SDK 类型

## 安装

```sh
npm install @dokploy/sdk
```

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

## README

# 多克普罗伊SDK

脚本 SDK 类型 [多克宝利](https://dokploy.com/) API——由OpenAPI spec自动生成.

## 安装

```bash
npm install @dokploy/sdk
# or
pnpm add @dokploy/sdk
```

## 使用量

```ts
import { client, applicationCreate, applicationOne, projectCreate } from "@dokploy/sdk";

// Configure the client with your Dokploy instance URL and API token
client.setConfig({
  baseUrl: "https://your-dokploy-instance.com/api",
  headers: {
    "x-api-key": "YOUR_API_TOKEN",
  },
});
```

### 创建工程

```ts
const { data, error } = await projectCreate({
  body: {
    name: "my-project",
    description: "My awesome project",
  },
});
```

### 部署应用程序

```ts
const { data, error } = await applicationCreate({
  body: {
    name: "my-app",
    projectId: "project-id",
  },
});
```

### 获取应用程序细节

```ts
const { data, error } = await applicationOne({
  query: { applicationId: "app-id" },
});

console.log(data?.name);
```

## API 覆盖范围

整个Dokploy API共有524个终点:

| 类别 | 资源 |
| --- | --- |
| 应用程序 | `application`, (中文(简体) ), `compose`, (中文(简体) ), `docker` |
| 数据库 | `postgres`, (中文(简体) ), `mysql`, (中文(简体) ), `redis`, (中文(简体) ), `mongo`, (中文(简体) ), `mariadb` |
| 基础设施 | `server`, (中文(简体) ), `cluster`, (中文(简体) ), `swarm`, (中文(简体) ), `registry` |
| 联网 | `domain`, (中文(简体) ), `port`, (中文(简体) ), `redirects`, (中文(简体) ), `certificates`, (中文(简体) ), `sshRouter` |
| 图形 | `github`, (中文(简体) ), `gitlab`, (中文(简体) ), `gitbucket`, (中文(简体) ), `gitea`, (中文(简体) ), `gitProvider` |
| 存储 | `mounts`, (中文(简体) ), `backup`, (中文(简体) ), `destination`, (中文(简体) ), `volumeBackups` |
| 平台 | `project`, (中文(简体) ), `deployment`, (中文(简体) ), `rollback`, (中文(简体) ), `schedule`, (中文(简体) ), `environment` |
| 系统 | `admin`, (中文(简体) ), `settings`, (中文(简体) ), `security`, (中文(简体) ), `user`, (中文(简体) ), `organization`, (中文(简体) ), `ai` |

## 重新生成 SDK

如果您更新 `openapi.json`,将 SDK 重生为:

```bash
pnpm generate
```

## 许可证

Apache 2.0 (英语)

## 常见问题

### @dokploy/sdk 是什么？

Dokploy API 的脚本 SDK 类型

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

在项目目录运行 npm install @dokploy/sdk，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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