Skip to content

docker/node-sdk

Repository files navigation

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
  • ContainerAttachWebsocket
  • 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
  • SystemPingHead
  • 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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages