10 breaking releases

0.31.0 Apr 30, 2020
0.29.2 Feb 19, 2020
0.28.1 Jan 30, 2020
0.22.0 Dec 10, 2019
0.7.0 Jun 26, 2019

#72 in #environments

Download history 42/week @ 2024-03-28 20/week @ 2024-04-04 5/week @ 2024-06-27 64/week @ 2024-07-04

69 downloads per month
Used in wf2

MIT and GPL-3.0-only

340KB
8K SLoC

wf2 - reliable docker environments

wf2 is a CLI tool for creating reliable, opinionated docker environments for local development.

wf2

Express Install

Simply run the following in your terminal

zsh <(curl -L https://raw.githubusercontent.com/WeareJH/wf2/master/express-install.sh) && source ~/.zshrc

Install

wf2 is distributed as a single binary with everything packaged inside - this means you do not need PHP or Composer installed on your machine.

  1. Download the latest version from the releases page

  2. Make the file executable: (assuming it downloaded to the Downloads folder)

    chmod +x ~/Downloads/wf2

  3. Move the executable from your Downloads folder to /opt

    sudo mv ~/Downloads/wf2 /opt

    • If "opt" does not exist run the command below

      sudo mkdir /opt

    • Then make sure the permissions are correct on the folder

      sudo chown -R $(whoami) /opt

  4. Add this to the bottom of your zshrc or bash_profile:

    export PATH="$PATH:/opt"

  5. Use the following command to refresh any already open terminals

    source ~/.zshrc

  6. Or for bash users

    source ~/.bash_profile

  7. Type the following command to check all is installed OK:

    wf2

  8. You should see the same output as below (in features):

Help

For help on the commands available, run the following:

wf2 --help

--help is recipe specific. So if you're in a M2 project, you'll only see commands that are relevant to M2 sites.

If you just want to explore what the the wf2 tool can do in each recipe, just use the --recipe command

# See M2 help
wf2 --recipe M2 --help

# See Wp help
wf2 --recipe Wp --help

Contributing.

Before pushing any code, run the following to ensure you catch problems before they get to CI

bash pre-push.sh

Dependencies

~28–41MB
~707K SLoC