env-setup

A workstation provisioner powered by Ansible / Homebrew for either macOS or Linux.

Quickstart

Get started with env-setup:

1. Init: bash <(curl -sL jig.io/env-setup)
2. Config: env-setup -c

• none: You want an empty config.
• mini: You want a minimum config.
• default: You want a workable default config.
• most: You want it all.
• custom: You want a new config.yml config started.

3. Run: env-setup

Usage

Init

The initialize command will verify you have git & a SSH key to retrieve this repo. You'll need to allow a new SSH key in GitHub if not already set. It will install the tool in your home dir under env-setup.

Config

The configuration yml file (config.yml) contains a manifest of Ansible variables that define what should be installed in your environment. You can change the values in config.yml to fit what your environment setup needs.

env-setup has a few starter config templates from these starter scenarios:

• none: You don't need an environment setup, but you want the env-setup tool for later use.
• mini: You want a environment setup with only the basic functionality (scripts, Homebrew, & Ansible).
• default: You workable default environment setup that will be used semi-often.
• most: You want it all in a environment setup that you'll use often.
• custom: You want a custom config.yml that you'll specify on your own.

Run

When env-setup is first run it will verify you have Ansible. After that, you'll be prompted to select an Ansible playbook to run. Optionally, you can specify what playbook to run directly (e.g. env-setup 01-config will run the config playbook directly, env-setup all will run all playbooks in sequential order)

Updating

Running env-setup -u will update the installed repo alongside the installed dotfiles repo.

Playbooks

An Ansible playbook is a series of tasks that need to run to get to your wanted setup. env-setup has 5 main playbooks with other optional ones based on your needs.

• 01-config: Configure your dotfiles for your app & CLI configuration (defaults to env-setup-dotfiles if not overridden)
• 02-cli-tools: Install CLI tools via Homebrew formulas
• 03-apps: Install GUI applications via Homebrew casks & other means (e.g., Linux package manager & App Store via mas)
• 04-packages: Install common programming language (Go/Node/PHP/Ruby/Rust/Python) dependencies for development tooling.
• 05-repos: Clones Git repos used for active development (projects) or reference (vendors).

See custom playbook section for adding other playbooks as needed.

Custom Playbook

To get started with a custom playbook:

• run ./scripts/add-playbook 09-my-playbook

This will setup the directory structure in the ansible dir and make it selectable in the env-setup tool.

From there, you can edit:

• ansible/*/09-my-playbook/main.yml to add your playbook tasks
• ansible/*/09-my-playbook/requirements.yml to add any ansible-galaxy dependencies for the playbook.

Development

See the development README.