# dockr

> Automatically build docker image and push it to your registry.

Latest version **1.2.1** (published 2016-05-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install dockr
pnpm add dockr
yarn add dockr
bun add dockr
```

## 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 | 1.2.1 |
| Published | 2016-05-09 |
| First published | 2016-04-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Bjarne Oeverli |
| Maintainers | bjarneo |
| Keywords | docker, image, tag, push, registry |

## Links

- npm: https://www.npmjs.com/package/dockr
- Repository: https://github.com/bjarneo/dockr
- Issues: https://github.com/bjarneo/dockr/issues
- npm.io page: https://npm.io/package/dockr

## Dependencies (2)

- [ora](https://npm.io/package/ora.md) 0.2.1
- [zero-pad](https://npm.io/package/zero-pad.md) 1.0.2

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2016-05-09
- 1.2.0 — 2016-05-09
- 1.1.2 — 2016-05-01
- 1.1.1 — 2016-04-14
- 1.1.0 — 2016-04-11
- 1.0.1 — 2016-04-10
- 1.0.0 — 2016-04-10

## README

Dockr
======
![Travis](https://travis-ci.org/bjarneo/dockr.svg?branch=master)

Automatically build docker image and push it to your registry.

Installation
------
```bash
$ npm i --save dockr
```

Usage
------
```js
const execute = require('dockr');

execute({
    registry: 'docker.yourRegistry.com', // default '' which pushes to docker.io/library
    username: 'username', // default ''
    imageName: 'myawesomeimage', // default ''
    dockerFileLocation: '.', // default '.' current location,
    timestamp: true, // default false. Append timestamp to the docker tag,
    verbose: true // default false. Console log docker process.
}).then(tag => {
    console.log('Image successfully pushed to %s', tag);
}).catch(console.error);
```

Tests
------
```bash
$ npm test
```

Inspiration
------
[grunt-dockerbuild](https://github.com/olesku/grunt-dockerbuild)

Contribution
------
Contributions are appreciated.

License
------
MIT-licensed. See LICENSE.

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