@docker/node-sdk

中文文档
0.0.17发布于 2025/10/30Apache-2.0TypeScriptESM + CJS近 30 天下载 5.1万

TypeScript SDK for Docker API

原始使用文档
文档目录14 节
  1. Installation
  2. Usage
  3. License
  4. Supported APIs:
  5. Container
  6. Image
  7. Network
  8. Volume
  9. Exec
  10. Plugin
  11. System
  12. Distribution
  13. Session
  14. Swarm

Docker Node SDK, a TypeScript SDK for Docker API

logo

Node-SDK is a TypeScript library to access Docker engine API (a.k.a "Moby").

Installation

npm install @docker/node-sdk

Usage

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

const docker = await DockerClient.fromDockerConfig();

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

License

Licensed under Apache License version 2.0 Copyright 2025, Docker Inc

tl;dr: You're free to use this code, make any changes you need, have fun with it. Contributions are welcome if you miss something.

Supported APIs:

Container

  • ContainerList
  • ContainerCreate
  • ContainerInspect
  • ContainerTop
  • ContainerLogs
  • ContainerChanges
  • ContainerExport
  • ContainerStats
  • ContainerResize
  • ContainerStart
  • ContainerStop
  • ContainerRestart
  • ContainerKill
  • ContainerUpdate
  • ContainerRename
  • ContainerPause
  • ContainerUnpause
  • ContainerAttach
  • ContainerWait
  • ContainerDelete
  • ContainerArchiveInfo
  • ContainerArchive
  • PutContainerArchive
  • ContainerPrune

Image

  • ImageList
  • ImageBuild
  • BuildPrune
  • ImageCreate
  • ImageInspect
  • ImageHistory
  • ImagePush
  • ImageTag
  • ImageDelete
  • ImageSearch
  • ImagePrune
  • ImageCommit
  • ImageGet
  • ImageGetAll
  • ImageLoad

Network

  • NetworkList
  • NetworkInspect
  • NetworkDelete
  • NetworkCreate
  • NetworkConnect
  • NetworkDisconnect
  • NetworkPrune

Volume

  • VolumeList
  • VolumeCreate
  • VolumeInspect
  • VolumeUpdate
  • VolumeDelete
  • VolumePrune

Exec

  • ContainerExec
  • ExecStart
  • ExecResize
  • ExecInspect

Plugin

  • PluginList
  • GetPluginPrivileges
  • PluginPull
  • PluginInspect
  • PluginDelete
  • PluginEnable
  • PluginDisable
  • PluginUpgrade
  • PluginCreate
  • PluginPush
  • PluginSet

System

  • SystemAuth
  • SystemInfo
  • SystemVersion
  • SystemPing
  • SystemEvents
  • SystemDataUsage

Distribution

  • DistributionInspect

Session

  • Session

Swarm

  • SwarmInspect
  • SwarmInit
  • SwarmJoin
  • SwarmLeave
  • SwarmUpdate
  • SwarmUnlockkey
  • SwarmUnlock
  • NodeList
  • NodeInspect
  • NodeDelete
  • NodeUpdate
  • ServiceList
  • ServiceCreate
  • ServiceInspect
  • ServiceDelete
  • ServiceUpdate
  • ServiceLogs
  • TaskList
  • TaskInspect
  • TaskLogs
  • SecretList
  • SecretCreate
  • SecretInspect
  • SecretDelete
  • SecretUpdate
  • ConfigList
  • ConfigCreate
  • ConfigInspect
  • ConfigDelete
  • ConfigUpdate

版本与发布记录

@docker/node-sdk 共发布 12 个版本,首次发布于 2025/09/24;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.17latest2025/10/301 年前
0.0.112025/10/151.1 年前
0.0.102025/10/151.1 年前
0.0.92025/10/151.1 年前
0.0.82025/10/141.1 年前
0.0.72025/10/141.1 年前

关于 @docker/node-sdk 的常见问题

@docker/node-sdk 是什么?

TypeScript SDK for Docker API

如何安装 @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 和提交记录判断。