# docker-api-wrapper

> The Docker API utils library

Latest version **0.2.16** (published 2015-09-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install docker-api-wrapper
pnpm add docker-api-wrapper
yarn add docker-api-wrapper
bun add docker-api-wrapper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.16 |
| Published | 2015-09-16 |
| First published | 2015-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+31 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | phuongle |
| Maintainers | thangchung, trumhemcut, jackyphuong |
| Keywords | docker, api, dockerapi, saigon, saigondevs |

## Links

- npm: https://www.npmjs.com/package/docker-api-wrapper
- Repository: https://github.com/saigon-devs/docker-api-wrapper
- Issues: https://github.com/saigon-devs/docker-api-wrapper/issues
- npm.io page: https://npm.io/package/docker-api-wrapper

## Dependencies (8)

- [fs](https://npm.io/package/fs.md) 0.0.2
- [http](https://npm.io/package/http.md) 0.0.0
- [util](https://npm.io/package/util.md) ^0.10.3
- [async](https://npm.io/package/async.md) ^1.4.2
- [axios](https://npm.io/package/axios.md) ^0.5.4
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [core-js](https://npm.io/package/core-js.md) ^1.1.1
- [querystring](https://npm.io/package/querystring.md) ^0.2.0

## Recent versions

- 0.2.16 (latest) — 2015-09-16
- 0.1.2 (beta) — 2015-07-28
- 0.2.15 — 2015-09-08
- 0.2.14 — 2015-09-08
- 0.2.12 — 2015-09-08
- 0.2.11 — 2015-09-04
- 0.2.10 — 2015-08-21
- 0.2.9 — 2015-08-21
- 0.2.8 — 2015-08-21
- 0.2.7 — 2015-08-21
- 0.2.6 — 2015-08-20
- 0.2.5 — 2015-08-20
- 0.2.4 — 2015-08-20
- 0.2.3 — 2015-08-11
- 0.2.2 — 2015-08-11
- … 4 more at https://npm.io/package/docker-api-wrapper/versions

## README

# Docker API Wrapper
[![npm version](https://badge.fury.io/js/docker-api-wrapper.svg)](http://badge.fury.io/js/docker-api-wrapper)
[![Build Status](https://travis-ci.org/saigon-devs/docker-api-wrapper.svg?branch=master)](https://travis-ci.org/saigon-devs/docker-api-wrapper)
[![bitHound Score](https://www.bithound.io/github/saigon-devs/docker-api-wrapper/badges/score.svg)](https://www.bithound.io/github/saigon-devs/docker-api-wrapper)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/saigon-devs/docker-api-wrapper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Docker API Wrapper that makes us call to the Docker API fast, easy and works like a charm...

# Use it

> `npm install docker-api-wrapper`

or 

> `npm install docker-api-wrapper --save-dev`

then 

> `import {Misc, Container, Image} from 'docker-api-wrapper';`

# Run integration testing

> If you want to make it works, please add ./spec/config.js file, then add
 
`module.exports = {
     server: '[your docker server ip]',
     port: [your docker port]
 };`
 
> `npm install`

> `npm run test`

# List API ([Docker Remote API v1.19](https://docs.docker.com/reference/api/docker_remote_api_v1.19/))

> **DONE**

1. Images
  * getImages
  * createImage
  * inspectImage
  * getImageHistory
  * removeImage
  * searchImages

2. Containers
  * getContainers
  * inspectContainer
  * inspectContainerChanges
  * getContainerResourceStats

3. Misc
  * getInfo
  * getVersion

> **TODO**

1. Images
  * Build image from a Dockerfile
  * Get the history of an image
  * Push an image on the registry
  * Tag an image into a repository
2. Containers
  * Create a container
  * Get container logs
  * Export a container
  * Get container stats based on resource usage
  * Resize a container TTY
  * Start a container
  * Stop a container
  * Restart a container
  * Kill a container
  * Rename a container
  * Pause a container
  * Unpause a container
  * Attach to a container
  * Attach to a container (websocket)
  * Wait a container
  * Remove a container
  * Copy files or folders from a container
3. Misc
  * Check auth configuration
  * Ping the docker server
  * Create a new image from a container�s changes
  * Monitor Docker�s events
  * Get a tarball containing all images in a repository
  * Get a tarball containing all images
  * Load a tarball with a set of images and tags into docker
  * Image tarball format
  * Exec Create
  * Exec Start
  * Exec Resize
  * Exec Inspect

> Demo Hapi Docker API with SwaggerUI [HDAS](https://github.com/saigon-devs/docker-api)

---
_Source: https://npm.io/package/docker-api-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._