Skip to content
This repository has been archived by the owner on Jul 7, 2020. It is now read-only.

inviqa/dock-cli

Repository files navigation

Dock CLI

Scrutinizer Code Quality Build Status

This CLI application provides an abstraction layer for Docker-based projects.

Note: right now, it's focused on OSX and Debian-based Linux distributions.

Getting started

This tool also helps you to install our recommended Docker setup on your computer, including direct container routing and DNS resolutions.

Read the installation instructions.

Project-related usage

You can now start up a specific project by running the start command in the project directory:

dock-cli start

Once the containers are compiled and started, this start command will display you an overview of the running components and their addresses (that you can also to have later with the ps command).

Example output using the docker-php-example project

Commands

The following commands are available:

System commands

Project commands

  • start command starts the Docker environment for the project.
  • stop command stops the running Docker containers of the project.
  • ps command list all the project containers if any.
  • logs command follows the logs of all or a given container.
  • run command run a command in a container with the application context.
  • reset command kill, remove and starts the containers.
  • build command build Docker images and resets the containers.

Plugins

In order to improve developer experience, we are also shipping dock-cli with some plugins.

  • Extra host names that will automatically configure your system to use given host names for your application components.

Update

To update this tool, simply run the self-update command:

dock-cli self-update

Contributing

Note If you are cloning this repository then one of the packages included in the vendors requires the ssh2 PHP extension. If you do not have this installed and do not require the associated functionality then you can ignore this requirement when installing the vendors:

composer install --ignore-platform-reqs