docker/node-sdk
1
0
Fork 0
mirror of https://github.com/docker/node-sdk synced 2026-04-05 19:45:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
134 commits 4 branches 13 tags 3.1 MiB
  • TypeScript 98.7%
  • Mustache 0.4%
  • JavaScript 0.3%
  • Dockerfile 0.2%
  • HCL 0.2%
  • Other 0.1%
Find a file
Exact
Nicolas De Loof 47ac3bcd0a prefer node:test 
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2025-11-01 19:09:28 +01:00
.github fix release workflow 2025-10-30 14:51:59 +01:00
lib fix release workflow 2025-10-30 14:51:59 +01:00
templates introduce RegistryClient to interact with an OCI registry 2025-10-14 08:14:44 +02:00
test prefer node:test 2025-11-01 19:09:28 +01:00
test-integration prefer node:test 2025-11-01 19:09:28 +01:00
.dockerignore Enabled additional oxlint plugins and categories 2025-10-16 06:54:21 +02:00
.editorconfig fixed .editorconfig 2025-09-24 08:51:45 +02:00
.gitignore Dockerize the build 2025-10-13 17:51:14 -04:00
.node-version Added actions/setup-node to GHA to use .node-version 2025-09-24 08:51:45 +02:00
.nvmrc nvmrc 2025-10-09 16:47:05 +02:00
.oxlintrc.json Enabled additional oxlint plugins and categories 2025-10-16 06:54:21 +02:00
.prettierignore refactored sendHTTPRequest by introducing an explicit httpRequest type 2025-09-18 15:04:55 +02:00
.prettierrc.yml configure prettier and apply format 2025-09-18 10:11:59 +02:00
bake_test_all.sh Dockerize the build 2025-10-13 17:51:14 -04:00
docker-bake.hcl Dockerize the build 2025-10-13 17:51:14 -04:00
Dockerfile Dockerize the build 2025-10-13 17:51:14 -04:00
LICENSE GitHub project structure 2025-09-17 08:37:28 +02:00
logo.png logo with JS monster (unofficial mascott) 2025-09-16 16:38:34 +02:00
main.ts Address lint warnings: 2025-10-14 08:15:57 +02:00
makefile Enabled additional oxlint plugins and categories 2025-10-16 06:54:21 +02:00
openapi-config.yaml introduce JSONMessage for streaming contents 2025-10-16 16:01:03 +02:00
openapitools.json configure prettier and apply format 2025-09-18 10:11:59 +02:00
package-lock.json prefer node:test 2025-11-01 19:09:28 +01:00
package.json prefer node:test 2025-11-01 19:09:28 +01:00
README.md implement ContainerExport 2025-10-02 17:30:26 +02:00
RELEASE.md redesign json-stream functions to rely on AsyncGenerator 2025-10-15 15:13:44 +02:00
swagger.yaml Added standard FE tech stack for bundling, testing, and formatting 2025-09-17 22:23:40 +02:00
tsconfig.json Fixed issue exporting Docker API Types 2025-10-13 20:33:16 +02:00
tsdown.config.ts Fixed issue exporting Docker API Types 2025-10-13 20:33:16 +02:00
vitest.config.ts Dockerize the build 2025-10-13 17:51:14 -04:00

README.md

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