This package has been deprecated

Author message:

dockersock has been deprecated in favour of @mojoio/docker - please upgrade asap!!!

dockersock
TypeScript icon, indicating that this package has built-in type declarations

1.0.23 • Public • Published

dockersock

easy communication with docker remote api from node, TypeScript ready

Availabililty

npm git git docs

Status for master

build status coverage report npm downloads per month Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

import {Dockersock} from "dockersock"; // require Dockersock class
 
let myDockersock = new Dockersock(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock
 
myDockersock.listContainers() // promise, resolve gets container data
myDockersock.listContainersDetailed() // promise, resolve gets more detailed container data (by combining several requests internally)
myDockersock.listContainersRunning() // promise, resolve gets container data for currently running containers
myDockersock.listContainersStopped() // promise, resolve gets container data for stopped containers
 
myDockersock.startContainer({ // starts a already present container
    name: "somecontainername"
})
 
myDockersock.newContainer({ // start new Container, equals "docker run" shell command
    image: "someimagetag"
})
 

For further information read the linked docs at the top of this README.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer

Package Sidebar

Install

npm i dockersock

Weekly Downloads

3

Version

1.0.23

License

MIT

Last publish

Collaborators

  • lossless
  • philkunz