![](https://private-user-images.githubusercontent.com/1087111/255377824-7ad0d467-384e-483c-8dcd-b63c19d90c3e.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM2OTM5NzAsIm5iZiI6MTcyMzY5MzY3MCwicGF0aCI6Ii8xMDg3MTExLzI1NTM3NzgyNC03YWQwZDQ2Ny0zODRlLTQ4M2MtOGRjZC1iNjNjMTlkOTBjM2UucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDgxNSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA4MTVUMDM0NzUwWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NTA5N2MwNGRjYzAzZGJlNWVjNDA4MWE1NDQ4NDlhODNhZDExMDcxMzNhODNhNDk3ZTk3YTFlOTg3ZWQzZDg1YiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.soymUmy5Y_lakYOJigi6GB1x4wAxKbHyom3CFRE2lJw)
A workstation provisioner powered by Ansible / Homebrew for either macOS or Linux.
Get started with env-setup
:
- Init:
bash <(curl -sL jig.io/env-setup)
- 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 newconfig.yml
config started.
- Run:
env-setup
![](https://private-user-images.githubusercontent.com/1087111/255443694-0e6b5b99-477c-49df-b6f3-42e908dffa8a.gif?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM2OTM5NzAsIm5iZiI6MTcyMzY5MzY3MCwicGF0aCI6Ii8xMDg3MTExLzI1NTQ0MzY5NC0wZTZiNWI5OS00NzdjLTQ5ZGYtYjZmMy00MmU5MDhkZmZhOGEuZ2lmP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDgxNSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA4MTVUMDM0NzUwWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MDEzMmFiMTZmOTJmODU5YTkyODhhMWZjN2EyYmUwNzk1MDg5MWRlODJmNmU5NGFkZDMxYWUyMDY1YjQxYzlkOSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.NnBXSZN5TgvRMaU5LRonj79Dd7NkajkIdn6ORUlse-o)
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
.
![](https://private-user-images.githubusercontent.com/1087111/255446849-4abc41e2-79b0-4f11-9504-ce9221852d83.gif?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM2OTM5NzAsIm5iZiI6MTcyMzY5MzY3MCwicGF0aCI6Ii8xMDg3MTExLzI1NTQ0Njg0OS00YWJjNDFlMi03OWIwLTRmMTEtOTUwNC1jZTkyMjE4NTJkODMuZ2lmP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDgxNSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA4MTVUMDM0NzUwWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YzJkN2U1MDAxNzM0MDM2M2NkOWI0NTBlNmRhZDI2NDI0MGIwMjI0MWEwZjQ2ZTY0NmE3ZGYyNWMwOWFmYWZlMCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.hqjCZnPxbRlgFEcXGBP3OqKHFgIZ3VCACiZGuqAFzlw)
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 theenv-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 customconfig.yml
that you'll specify on your own (see an example config.yml)
![](https://private-user-images.githubusercontent.com/1087111/255449234-7d30e859-b7c6-4f21-b35d-879ae550a4f7.gif?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM2OTM5NzAsIm5iZiI6MTcyMzY5MzY3MCwicGF0aCI6Ii8xMDg3MTExLzI1NTQ0OTIzNC03ZDMwZTg1OS1iN2M2LTRmMjEtYjM1ZC04NzlhZTU1MGE0ZjcuZ2lmP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDgxNSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA4MTVUMDM0NzUwWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9OTdmYmVlOGMwZGJmZWJhZTliZGI0MjYxYWMwMWRkMGQ1YjcyZmJjMDQ5NDE5YWE0NDY1YWRkOGRjMmZkMzJjYSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.uI0YRVhIpDwXWheKlFQeV16_UC4OKUDThJKv8A2SxYc)
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)
Running env-setup -u
will update the installed repo alongside the installed
dotfiles repo.
An Ansible playbook is a series of tasks that need to run to get to your wanted setup.
env-setup
has 8 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
: Install CLI tools via Homebrew formulas03-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).06-os
: Configure the OS settings.07-cloud
: Configure the host for cloud file sync.08-prefs
: Configure any other app settings.
See custom playbook section for adding other playbooks as needed.
If you like a list of what tasks in a playbook will do, run env-setup -i
with
the playbook name (e.g. env-setup -i 03-apps
). It will print an ordered task
list, with a description and tags that describe what the playbook will do.
If you'd like to skip tasks in a playbook, each task have tags associated
with them. You can select tags with the -t
option or skip tags with the -s
option. You can specify multiple tags by comma-delimiting. For example:
env-setup -t node,python 04-packages
: Install only Node & Python packages.env-setup -s php 04-packages
: Install all packages, except PHP packages.
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 tasksansible/*/09-my-playbook/requirements.yml
to add any ansible-galaxy dependencies for the playbook.
See the development README.