Clean-macOS icon indicating copy to clipboard operation
Clean-macOS copied to clipboard

💻 A script to set up a clean macOS environment.

Clean-macOS logo

Clean-macOS

Status GitHub
Issues License Version


Clean-macOS is a simple script that can be used after a clean installation of macOS to configure and install all the apps you need. It uses dotfiles and shell scripts to speed up the configuration of macOS.

Table of content

  • Table of content
  • Getting Started
  • Requirements
  • Usage
  • Contributing
  • Useful links
  • Credits

Getting Started

Requirements

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

Usage

  1. Clone this repo with the following command:
git clone https://github.com/MarioCatuogno/Clean-macOS.git ~/Clean-macOS
  1. Open Terminal.app and run the command:
chmod -R 755 ~/Clean-macOS && ~/Clean-macOS/Clean-macOS.sh

The following prompt will appear from which you can choose one of the options:

Clean-macOS terminal

  1. Install: install Homebrew package, binaries, casks, dependencies, and Mac Apple Store application listed in Brewfile file
  2. Configure: configure macOS with useful commands, update zsh and preferences
  3. Update: update brews, casks, and MAC applications and formulaes

Find a step-by-step guide here.

Contributing

You are encouraged to fork this repository and open an issue to discuss the change you wish to make. If you want to contribute, please read our contributing guidelines.

Useful links

Click here to find a collection of various apps I've personally tested or used in the past on macOS.

Click here to find the full changelog history.

Click here to find the current status and the upcoming milestones of the Clean-macOS project.

Credits


Clean-macOS desktop