# docker-helper-cli

> Utility to work with docker-compose at development time, many people use make to do this, but we can make it much better using nodejs

Latest version **1.0.10** (published 2018-04-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install docker-helper-cli
pnpm add docker-helper-cli
yarn add docker-helper-cli
bun add docker-helper-cli
```

Provides the commands `dhc`, `docker-helper-cli`.

## 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.0.10 |
| Published | 2018-04-08 |
| First published | 2018-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8.0 |
| Dependencies | 3 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Rodrigo Silva Rahman de Almeida |
| Maintainers | rodrigorahman |
| Keywords | docker, cli, dockerCLI, dockerHelper |

## Links

- npm: https://www.npmjs.com/package/docker-helper-cli
- Repository: https://github.com/rodrigorahman/docker-helper-cli
- Homepage: https://rodrigorahman.github.io/docker-helper-cli/
- Issues: https://github.com/rodrigorahman/docker-helper-cli/issues
- npm.io page: https://npm.io/package/docker-helper-cli

## Dependencies (3)

- [inquirer](https://npm.io/package/inquirer.md) ^5.2.0
- [commander](https://npm.io/package/commander.md) ^2.15.1
- [app-root-path](https://npm.io/package/app-root-path.md) ^2.0.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.10 (latest) — 2018-04-08
- 1.0.9 — 2018-04-08
- 1.0.8 — 2018-04-07
- 1.0.7 — 2018-04-07
- 1.0.6 — 2018-04-05
- 1.0.5 — 2018-04-05
- 1.0.4 — 2018-04-04
- 1.0.3 — 2018-04-04
- 1.0.2 — 2018-04-04
- 1.0.1 — 2018-04-04
- 1.0.0 — 2018-04-04

## README

# Instalação 

Instale sempre esse pacote como global pois só assim ele poderá se executado de qualquer pasta

```
npm i docker-helper-cli --global
```

# Visualizando lista de comandos

```
docker-helper-cli --help
```

**OU**

```
dhc --help
```

# Executando um start stack (docker-compose up)

```
docker-helper-cli s
```

**OU**

```
dhc s
```

## Para ao final ele mostrar o log da aplicação default utilize: 


```
docker-helper-cli s -l
```

**OU**

```
dhc s -l
```


# Configuracoes adicionais

Para facilitar sua vida você pode utilizar algumas configurações extras para seu projeto, para isso basta criar o arquivo dhc-config.json

Para dizer qual é a aplicação default para configurações como hotdeploy (hd) ou mesmo start com logs (s -l)

```json
{
  "defaultWebProjectName" : "service-name-defined-in-docker-compose",
}
```

## Para adicionar a lista de escolhas no rebuild de um projeto

Para isso basta adicionar as apps dentro do atributo appsEnabled

```json
{
  "defaultWebProjectName" : "service-name-defined-in-docker-compose",
  "appsEnabled": [
    {"name": "redis"},
    {"name": "consul"}
  ]
}
```

## Criando seus proprios comandos 

Para criar seus comandos você deve adicionar a tag customCommandExec.


ex:
```json
{
  "defaultWebProjectName" : "service-name-defined-in-docker-compose",
  "appsEnabled": [
    {"name": "redis"},
    {"name": "consul"}
  ],
  "customCommandExec": [
    {
      "name": "docker ps",
      "description": "lista as dockers",
      "alias": "ps",
      "command":["docker ps", "docker ps -a"] 
    },
    {
      "name": "docker ps -a",
      "description": "lista as dockers",
      "alias": "psa",
      "command": ["docker ps -a"]
    }
  ]
}
```

# Para projetos não JAVA

Caso você não trabalhe com java e queira utilizar a nossa lib.

Basta adicionar o atributo "javaProject" na configuração.

ex:

```json
{
  "defaultWebProjectName" : "service-name-defined-in-docker-compose",
  "javaProject": false
}
```

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