• Setup
  • Automate Mac Setup
  • Installation Types
    • Main
    • Essentials
    • Secondary
  • Modes
  • Options
  • Customizable Setup
    • Manual
  • Useful Commands
  • Install homebrew for each user
  • Contribute

New Mac? Clean macOS install? Run Setup and automate it all!

Get most of the tedious configurations, application installs, and other settings automatically configured on your Mac.

• Installs Homebrew
• Installs Xcode Developer Tools
• Installs necessary applications and tools
• Sets up environment (executables/tools (git, npm, etc), shells (defaults, prompts, etc), CLIs, and more)
• Additional environment configurations
• Updates macOS

Start with a Customizable Setup run.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/bretonics/Setup/HEAD/setup.sh)"

Cancel the auto run with Ctrl-C if you want to modify apps.txt, formulae.txt, casks.txt, and/or Brewfile.

See Customizable Setup for a better way to utilize a custom Setup.

This install includes the entire app, formulae, and cask collection, including those in the essentials install type and all modes. This is more for something like a Mac mini.

See the default Brewfile.

This install includes a smaller subset of what I deem essential, must haves. It's intended more for a Macbook Pro where you don't need everything under the sun.

See the default Brewfile.

Secondary setup modifies personalized Mac settings, and is run after the initial install. It requires more attention as it may ask for credential or information input. It runs by default if running 'main' type. You must pass the -s option otherwise, or you can always run it directly bash ./secondary.sh.

Directories in ./src/mode separate other installation modes that can be run in addition to the 'main' or 'essentials' install chosen.

Each directory keeps track of individual programs (Apps, Formulae, and Casks) to install for the specific mode, via their own Brewfile, and includes an install.sh for all logic pertaining to the mode.

Available modes:

• dev
• fun

$ ./install.sh -h

Usage: install.sh [Options] Brewfile


Running install without any options below will run a MAIN setup by default.


Options:

    -B                      Sync backups from latest Time Machine backup
    -D                      Use defaults (skip confirmation when applying secondary settings)
    -E                      Essentials only installations
    -F                      Run full main install with defaults (Sets -B, -D, -P, and -s)
    -M                      Main install type (-s=true)
    -P                      Set Mac setting system preference defaults (Default: false)
    -i [main|essentials]    Explicit install type declaration, i.e. -M or -E)
    -m <mode>               Run additional specified mode installation (in ./src/mode)
    -s                      Run secondary installation (Default: false)
    -h                      Prints this usage message

Arguments:

    Brewfile                Path to Brew bundle file (Default: './src/Brewfile')

I suggest using your own Brewfile. If you don't have one, see Useful Commands to create one before running Setup, and pass this to the program as followed:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/bretonics/Setup/HEAD/setup.sh)" "" ~/absolute/path/to/Brewfile

You can also pass any of the available options:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/bretonics/Setup/HEAD/setup.sh)" "" -E

You probably want to do this --unless you really like everything configured as I do (we both know you don't)--and don't have a Brewfile to run a customized setup.

Download the repo or fork it to do a custom install and modify the following:

Brewfile

Modify the ./src/Brewfile and run bash install, or pass your own: bash install /absolute/path/to/my/Brewfile.

Personalizations

1. Modify files containing list of apps and their respective Mac App Store product identifiers, formulae, and/or casks that you want installed in the src directory.

2. Run bash install.sh -E

3. Optional: bash secondary.sh

# List all installed Mac apps
mas list | sort -fk 2

# Create Brewfile
brew bundle dump

# Create custom java symlink
 sudo ln -sfn ~/homebrew/opt/openjdk/libexec/openjdk.jdk \
     /Library/Java/JavaVirtualMachines/openjdk.jdk

According to the brew documentation you can install it inside each User Home folder

That way all packages are going to stay inside your user folder, and will not be visible or affect other users. As a good side effect if you delete that user, no trash is left behind on your system. So system wide pollution is minimised.

This comes at the cost of more storage being used, if you install the same package for multiple users. Just something to be aware if you have a very small SSD.

Instructions If you currently have brew installed on your system globally, I recommend uninstalling brew first. (You can see where brew is installed running which brew)

If you don't have Command Line Tools installed, you have to run this first:

xcode-select --install

Open terminal and Run:

MacOS Catalina 10.15 or newer:

cd $HOME
mkdir homebrew && curl -L https://github.com/Homebrew/brew/tarball/master | tar xz --strip 1 -C homebrew
echo 'export PATH="$HOME/homebrew/bin:$PATH"' >> .zprofile

MacOS Mojave 10.14 or older:

cd $HOME
mkdir homebrew && curl -L https://github.com/Homebrew/brew/tarball/master | tar xz --strip 1 -C homebrew
echo 'export PATH="$HOME/homebrew/bin:$PATH"' >> .bash_profile

Close the Terminal window

Open Terminal again, and run this to ensure your installation is correct:

brew doctor

Done!

Disabling auto update

This is not required I also find useful to disable brew to update all packages before every time you install something.

MacOS Catalina 10.15 or newer

echo 'HOMEBREW_NO_AUTO_UPDATE=1' >> $HOME/.zprofile
MacOS Mojave 10.14 or older
echo 'HOMEBREW_NO_AUTO_UPDATE=1' >> $HOME/.bash_profile

Have a particular set of configurations to add? Feel free to create a PR!

If there's a particular set of commands, applications, or utilities you find useful, add an additional install mode (-m myMode).

• Create a directory with the mode's name under src, i.e. src/mymode (lowercase)
• The entrypoint is set to $MODE_INSTALL_FILE
• A mode's entrypoint should be named install.sh
• install.sh should be located in the named mode's directory, e.g. src/mymode
• A mode's logic should be called from this entrypoint
• Any and all files related to a mode are to be contained in the mode's root directory, i.e. src/mymode
• You can use a Brewfile to organize and handle all resource installations (called from a mode's install.sh), or add individual text files for each set of apps, formulae, and casks (1 entry per line) and pass the file reference to these functions:
  • installApps
  • installFormulae
  • installCasks
• It's encourage to mimic the root directory's structure, but it's not required

├── src/mymode
       ├── Brewfile
       ├── apps.txt
       ├── casks.txt
       ├── formulae.txt
       ├── install.sh
       ├── npm.txt
       ├── taps.txt
       └── vscode.txt