# @docker/node-sdk 中文文档

规范地址：https://npmcn.com/package/%40docker/node-sdk/

版本：0\.0\.17
npm 元数据更新时间：2026-07-01T10:03:00.983Z
中文译文更新时间：2026-11-12T13:49:34.681Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.7 MB，267 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^18\.0\.0 \|\| ^20\.0\.0 \|\| \>=22\.0\.0
- 运行依赖：3 个
- 首次发布：2025-09-23T16:41:07.095Z
- 最新版本发布：2025-10-30T13:53:50.280Z
- 近 30 天下载量：50774（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 0 个）

## 中文简介

Docker API 的脚本 SDK

## 安装

```sh
npm install @docker/node-sdk
```

也可以使用：`pnpm add @docker/node-sdk`、`yarn add @docker/node-sdk`、`bun add @docker/node-sdk`

## README

# Docker 节点 SDK,用于 Docker API 的 SDK 类型脚本

![logo](https://npmcn.com/package/%40docker/node-sdk/logo.png)

节点- SDK 是一个用于访问的 TypeScript 库 [多克引擎 API](https://docs.docker.com/reference/api/engine/#view-the-api-reference) (a.k.a"莫比").

## 安装

```bash
npm install @docker/node-sdk
```

## 使用量

```typescript
import { DockerClient } from '@docker/node-sdk';

const docker = await DockerClient.fromDockerConfig();

const containers = await docker.containerList({ all: true });
console.dir(containers);
```

## 许可证

许可证根据 [Apache 许可证版本 2.0](https://www.apache.org/licenses/LICENSE-2.0) 版权2025,多克公司

_tl; 医生 :_ 你可以自由使用这个代码, 做任何你需要的修改, 玩得开心. 如果你错过什么,欢迎捐款.

## 支持的 API :

### 集装箱

-   [x] 集装箱列表
-   [x] 容器创建
-   [x] 集装箱检查
-   [x] 集装箱Top
-   [x] 集装箱记录仪
-   [x] 集装箱变化
-   [x] 集装箱出口
-   [x] 集装箱数据
-   [x] 集装箱恢复
-   [x] 集装箱启动
-   [x] 集装箱停止
-   [x] 重新开始
-   [x] 集装箱杀戮
-   [x] 集装箱更新
-   [x] 容器重命名
-   [x] 集装箱暂停
-   [x] 集装箱停用
-   [x] 集装箱标签
-   [x] 集装箱等待
-   [x] 集装箱删除
-   [x] 集装箱档案信息
-   [x] 集装箱档案
-   [x] 装设容器 Archive
-   [x] 集装箱管道

### 图像

-   [x] 图像列表
-   [x] 图像构建
-   [x] 构建棱镜
-   [x] 图像创建
-   [x] 图像检查
-   [x] 图像历史
-   [x] 图像推出
-   [x] 图像标签
-   [x] 图像删除
-   [ ] 图像搜索
-   [x] 图像打印
-   [x] 图像承诺
-   [x] 图像获取
-   [x] 图像获取全部
-   [x] 图像记录

### 网络

-   [x] 网络列表
-   [x] 网络检查
-   [x] 网络删除
-   [x] 网络创建
-   [x] 网络连接
-   [x] 网络断开连接
-   [x] 网络程序

### 数量

-   [x] 音量列表
-   [x] 创建量
-   [x] 质量检查
-   [x] 音量更新
-   [x] 音量删除
-   [x] 音量纯度

### 执行

-   [x] 集装箱Exec
-   [x] 执行启动
-   [x] 执行恢复
-   [x] 检查

### 插件

-   [ ] 插件列表
-   [ ] 获取 Plugin 特权
-   [ ] 插件笔记
-   [ ] 插件检查
-   [ ] 插件删除
-   [ ] 可插件
-   [ ] 无法插件
-   [ ] 插件升级
-   [ ] 插件创建
-   [ ] 插件推开
-   [ ] 插件设置

### 系统

-   [x] 系统认证
-   [x] 系统信息
-   [x] 系统版本
-   [x] 系统平
-   [x] 系统事件
-   [x] 系统数据用户

### 分发

-   [ ] 分布检查

### 会议

-   [ ] 会议

### 沼泽

-   [ ] 鼠标检查
-   [ ] 沼泽
-   [ ] 沼泽
-   [ ] 沼泽地
-   [ ] 更新时间
-   [ ] 鼠标解锁
-   [ ] 自动解锁
-   [ ] 节点列表
-   [ ] 节点检查
-   [ ] 节点删除
-   [ ] 节点更新
-   [ ] 服务列表
-   [ ] 服务创建
-   [ ] 服务检查
-   [ ] 服务删除
-   [ ] 服务更新
-   [ ] 服务日志
-   [ ] 任务列表
-   [ ] 任务检查
-   [ ] 任务日志
-   [ ] 机密列表
-   [ ] 秘密创造
-   [ ] 秘密检查
-   [ ] 秘密删除
-   [ ] 保密更新
-   [ ] 配置列表
-   [ ] 配置
-   [ ] 配置检查
-   [ ] 配置删除
-   [ ] 配置更新

## 常见问题

### @docker/node-sdk 是什么？

Docker API 的脚本 SDK

### 如何安装 @docker/node-sdk？

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

### @docker/node-sdk 支持 TypeScript 吗？

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

### @docker/node-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @docker/node-sdk 需要什么版本的 Node\.js？

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

### @docker/node-sdk 可以商用吗？

@docker/node-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @docker/node-sdk 的下载量有多少？

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

### @docker/node-sdk 还在维护吗？

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

