Skip to content

Latest commit

 

History

History
89 lines (56 loc) · 2.87 KB

README.md

File metadata and controls

89 lines (56 loc) · 2.87 KB
Raw

Takeout - Docker-based dependency management for macOS

Takeout

Takeout is a Mac-based CLI tool for spinning up tiny Docker containers, one for each of your development environment dependencies.

With takeout install mysql you're running MySQL, and never have to worry about Homebrew MySQL again.

But you can also easily install ElasticSearch, Postgres, MSSQL, Redis, and more, with a simple command.

History

Tighten programmer Jose Soto has long been advocating (podcast, Laracasts) the usage of simple, small Docker containers for local development dependencies. Instead of building your entire local dev stack using something like Vessel, you use your existing web server (likely Laravel Valet) but rely on Docker for managing your services like MySQL and Redis.

Tighten programmer Matt Stauffer thought of the idea of packaging Jose's way of working with Docker up into a simple command-line tool, and Takeout was born.

Example services:

  • MySQL
  • Postgres
  • MSSQL
  • ElasticSearch
  • MeiliSearch
  • Redis
  • Memcached

Requirements

  • Docker for Mac installed

Installation

@todo

Usage

Install with no params

takeout install

Presents you with a menu of potential services to install.

Install passing service name

takeout install mysql

Installs this service if possible

Uninstall with no params

takeout uninstall

Presents you with a list of your installed services, and you can pick one to uninstall.

Uninstall with params

takeout uninstall mysql

Uninstalls this service if possible.

Future plans

  • self-remove: Deletes all installed services and then maybe self-uninstalls?
  • upgrade: v2: destroys old container, brings up a new one with a newly-specified tag (prompt user for it) and keeps all other parameters (e.g. port, volume) exactly the same as the old one
  • pt/passthrough: proxy commands through to docker (./takeout pt mysql stop)
  • Deliver package in a way that's friendly to non-PHP developers
  • Add 'upgrade' command, which saves the config settings for the old one, brings up a new one with the same tag and parameters, and allows you to re-specify the version constraint
  • Allow for more than one of each service (e.g. mysql 5.7, mysql 8, another mysql 8, etc.)
  • Allow other people to extend Takeout by adding their own plugins (thanks to @angrybrad for the idea!)

FAQs

Will this install the PHP drivers for me via PECL? 
Sadly, no.

Todo

See our Project Board for tasks.