# pon-task-docker-image

> Pon task to deal with docker image

Latest version **4.2.1** (published 2019-12-03) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install pon-task-docker-image
pnpm add pon-task-docker-image
yarn add pon-task-docker-image
bun add pon-task-docker-image
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.2.1 |
| Published | 2019-12-03 |
| First published | 2017-12-15 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 2 |
| Unpacked size | 64.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | FujiHaruka |
| Maintainers | fuji_haruka |
| Keywords | Pon |

## Links

- npm: https://www.npmjs.com/package/pon-task-docker-image
- Repository: https://github.com/realglobe-Inc/pon-task-docker-image
- Homepage: https://github.com/realglobe-Inc/pon-task-docker-image#readme
- Issues: https://github.com/realglobe-Inc/pon-task-docker-image/issues
- npm.io page: https://npm.io/package/pon-task-docker-image

## Dependencies (2)

- [pon-task-fs](https://npm.io/package/pon-task-fs.md) ^3.1.17
- [pon-task-command](https://npm.io/package/pon-task-command.md) ^3.1.6

## Recent versions

- 4.2.1 (latest) — 2019-12-03
- 4.2.0 — 2019-12-02
- 4.1.3 — 2019-08-27
- 4.1.2 — 2019-07-22
- 4.1.1 — 2019-07-19
- 4.1.0 — 2019-07-17
- 4.0.0 — 2019-07-17
- 3.5.1 — 2019-07-16
- 3.4.4 — 2019-06-26
- 3.4.3 — 2019-06-12
- 3.4.2 — 2019-06-12
- 2.0.1 — 2018-07-10
- 2.0.0 — 2018-07-10
- 1.0.2 — 2017-12-15

## README

pon-task-docker-image
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/realglobe-Inc/pon-task-docker-image
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/pon-task-docker-image
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/pon-task-docker-image.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/pon-task-docker-image
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/pon-task-docker-image.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/pon-task-docker-image/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/pon-task-docker-image
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/pon-task-docker-image.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/pon-task-docker-image.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/pon-task-docker-image
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/pon-task-docker-image.svg
[bd_npm_url]: http://www.npmjs.org/package/pon-task-docker-image
[bd_npm_shield_url]: http://img.shields.io/npm/v/pon-task-docker-image.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Pon task to deal with docker image

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install pon-task-docker-image --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

次のような image.json ファイルを作成する。

```json
{
  "name": "hello-world",
  "version": "latest",
  "registry": "registry.hub.docker.com/library"
}
```

build, push 等のタスクには image.json ファイルのあるディレクトリを指定する。


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Signature.md.hbs" Start -->

<a name="section-doc-guides-03-signature-md"></a>

Signatures
---------


### `build(dir, options)`

Task to build docker image

| Param | type | Description |
| ---- | --- | ----------- |
| dir | string |  docker build directory |
| options | Object |  Optional settings |
| options.confDir | string |  directory of Dockerfile, .dockerignore, image.json |
| options.force | boolean |  if false, skip build if image exists |


### `pull(dir, options)`

Task to pull docker image

| Param | type | Description |
| ---- | --- | ----------- |
| dir | string |  docker build directory |
| options | Object |  Optional settings |


### `push(dir, options)`

Task to push docker image

| Param | type | Description |
| ---- | --- | ----------- |
| dir | string |  docker build directory |
| options | Object |  Optional settings |


### `remove(dir, options)`

Task to remove docker image

| Param | type | Description |
| ---- | --- | ----------- |
| dir | string |  docker build directory |
| options | Object |  Optional settings |


### `run(dir, options)`

Task to run docker container

| Param | type | Description |
| ---- | --- | ----------- |
| dir | string |  docker directory |
| options | Object |  Optional settings |



<!-- Section from "doc/guides/03.Signature.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [Apache-2.0 License](https://github.com/realglobe-Inc/pon-task-docker-image/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [Pon][pon_url]
+ [Realglobe, Inc.][realglobe,_inc__url]

[pon_url]: https://github.com/realglobe-Inc/pon
[realglobe,_inc__url]: http://realglobe.jp

<!-- Links End -->

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