Package Exports

@crazyfactory/docker-project-cli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@crazyfactory/docker-project-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

docker-project-cli

A simple CLI tool simplify docker based project administration. Not meant to replace anything, just reducing your CLI overhead.

Installation

Install it globally for quick access

$ npm i -g @crazyfactory/docker-project-cli

Optionally install it locally, to pin down versions if required.

$ npm i --save @crazyfactory/docker-project-cli

Configuration

Configuration of DOPR can be done either via package.json under the dopr key or with a provided file defaulting to .dopr.json.

Default configuration

{
  "file": "./docker/docker-compose.yml",
  "service": null,
  "exec": true,
  "actions": {
    "down": {
      "command": "%action% %args%",
      "exec": false
    },
    "up": {
      "command": "%action% %args%",
      "exec": false
    },
    "start": {
      "command": "%action% %args%",
      "exec": false
    },
    "stop": {
      "command": "%action% %args%",
      "exec": false
    },
    "bash": "%action% %args%",
    "composer": "%action% %args%",
    "node": {
      "command": "%action% %args%",
      "user": "node"
    },
    "npm": "%action% %args%",
    "git": "%action% %args%",
    "yarn": "%action% %args%"
  }
}

Notes:

This will relay up, down, start and stop to docker-compose -f <file> $params$
This will add custom commands like dopr bash ..., dopr composer ... and dopr optimize
The node will be launched with the user node by default.
This will use a different config if NODE_ENV is set to production or if dopr is with --env production.

Usage

docker-compose shortcuts

dopr will choose the correct docker-compose file for you and relay some of the most basic commands directly to docker-compose.

To start you project in deamon mode run

$ dopr up -d

You can similarly use down and stop, just like you would with docker-compose directly.

custom commands

You can add simple custom commands, but we add some by default. They are passed through to the service specified in your dopr configuration.

For instance to open a bash session just run

$ dopr bash

You can similarly access node, npm, git and composer like so

$ dopr npm run my-script

or so

$ dopr composer dump-autoload -o

Using the configuration you can add your own commands. If you want to use yarn for instance, simply add it

{
  "action": [
    "yarn"
  ]
}

You can also specify a different service if required. So you can add shortcuts for other docker instances like mysql as well.

{
  "action": [
    {
      "key": "mysql",
      "service": "mysql-service"
    }
  ]
}

License

Licensed under the MIT license.

See LICENSE for more info.