# knorm-postgres

> postgres docker tools for knorm and its plugins

Latest version **2.0.0** (published 2017-08-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install knorm-postgres
pnpm add knorm-postgres
yarn add knorm-postgres
bun add knorm-postgres
```

Provides the command `knorm-postgres`.

## 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 | 2.0.0 |
| Published | 2017-08-02 |
| First published | 2017-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Joel Mukuthu |
| Maintainers | joelmukuthu |
| Keywords | knorm, postgres, docker |

## Links

- npm: https://www.npmjs.com/package/knorm-postgres
- Repository: https://github.com/joelmukuthu/knorm-postgres
- Homepage: https://github.com/joelmukuthu/knorm-postgres#readme
- Issues: https://github.com/joelmukuthu/knorm-postgres/issues
- npm.io page: https://npm.io/package/knorm-postgres

## Dependencies (2)

- [yargs](https://npm.io/package/yargs.md) ^8.0.1
- [shelljs](https://npm.io/package/shelljs.md) ^0.7.7

## Recent versions

- 2.0.0 (latest) — 2017-08-02
- 1.0.0 — 2017-08-02

## README

# knorm-postgres

postgres docker tools for [knorm](https://www.npmjs.com/package/knorm) and its
plugins.

### knorm-postgres start

starts a postgres container. if one doesn't exist, it creates it, downloading
the postgres image if necessary.

#### options:
- `name` *alias: `n`, default: `knorm-postgres`*: specifies the name of the
  postgres container.

Other configurations can be made using environment variables:

- `POSTGRES_PORT`: configures the port number for the container, defaults to
  `5616`
- `POSTGRES_USER`: configures the postgres user for the database, defaults to
  `knorm`
- `POSTGRES_PASSWORD`: configures the postgres password for the database,
  defaults to `knorm`
- `POSTGRES_DB`: configures the postgres database name for the database,
  defaults to `knorm`

### knorm-postgres stop

stops a running postgres container.

#### options:
- `name` *alias: `n`, default: `knorm-postgres`*: specifies the name of the
  postgres container.

### knorm-postgres remove

removes a running/stopped postgres container.

#### options:
- `name` *alias: `n`, default: `knorm-postgres`*: specifies the name of the
  postgres container.

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