Environment Setup

Automated environment setup and configuration for OpenGood computing environments

Pre-Requisites

• Access to GitHub with permissions to clone repos
• Familiarity with running commands and scripts from macOS Terminal

Compatibility

Installation is maintained for the recent version(s) of macOS and required tools:

Requirement	Version
macOS	Sonoma 14.x
Processor	Apple Mx

Getting Started

• Open Terminal and type git
• One will be prompted to install the required Command Line Developer Tools
• Once installed, run the following commands from Terminal:

Create workspace Directory

mkdir -p ~/workspace

Download Project

cd ~/workspace
git clone https://github.com/opengood-aio/env-setup
cd env-setup

Workstation Setup

Supported Packages

See Packages for list of supported packages.

Install Default Software/Tools

bin/setup-workstation.sh install all

Notes:

• One will be prompted to enter credentials to grant elevated privileges to install packages
• One will be prompted to interactively enter the path to Bash 5.0 shell, as this cannot be automated due to security restrictions in macOS requiring root level access to modify /etc/shells shells configuration file
• For Git, one will be prompted for the following information to complete the setup of various Git configurations:
  • Git name
  • Git email
  • GitHub username
  • GitHub password or access token (latter used for 2FA)
• After Maacy and Rectangle are installed, one will need to open the System Preferences and grant them elevated privileges under Security & Privacy > Privacy > Accessibility

Install Specific Software/Tools

bin/setup-workstation.sh install <package>

Update Everything

bin/setup-workstation.sh update

Uninstall Specific Software/Tools

bin/setup-workstation.sh uninstall <package>

Uninstall Everything

bin/setup-workstation.sh uninstall all

Bulk Git Pull/Rebase

At times, one needs to perform a git pull -r for multiple repos. This usually involves changing directories to each repo and manually issuing the above command.

To perform this recursively in all sub-directories with repos:

bin/pull-git-repos.sh ~/workspace