/Clean-macOS

💻 A script to set up a clean macOS environment.

Primary LanguageShellMIT LicenseMIT

Clean-macOS logo

Clean-macOS

Status GitHub Issues License Version

Clean-macOS is a script that automates the configuration of a new macOS installation. By using dotfiles and shell scripts, Clean-macOS can quickly configure macOS and install all the necessary apps.

Table of content

Getting Started

To get started with Clean-macOS, clone this repository using the command:

git clone https://github.com/MarioCatuogno/Clean-macOS.git ${HOME}/Clean-macOS

Requirements

Clean-macOS requires the following:

  1. An active internet connection
  2. macOS 10.15.0 or newer
  3. Signed in to Apple Store with your iCloud account

Usage

To use Clean-macOS, open Terminal.app and run the command:

chmod -R 755 ${HOME}/Clean-macOS && ${HOME}/Clean-macOS/Clean-macOS.sh

This will bring up a prompt with the following options:

Clean-macOS terminal

  1. Install: Install Homebrew packages, binaries, casks, dependencies, and Mac Apple Store applications listed in the Brewfile file.
  2. Configure: Configure macOS with useful commands, update zsh, and preferences.
  3. Update: Update brews, casks, and MAC applications and formulas.

A step-by-step guide for setting up Clean-macOS can be found here.

Contributing

You are welcome to contribute to Clean-macOS by forking this repository and opening an issue to discuss the changes you want to make. Please read our contributing guidelines before contributing.

Useful links

  • APPLIST: a collection of various apps I've personally tested or used. These apps are included in my Brewfile, which allows you to quickly and easily install them on your own machine using Homebrew.
  • CHANGELOG: the full changelog history.

Credits

Clean-macOS desktop