macos-scripted-setup's Introduction

Automate your macOS setup

Welcome to the macOS Scripted Setup.
This project helps Mac users quickly and easily set up a new computer or useraccount by automatically configuring a range of system settings and installing commonly used applications.

Tip

The scripted setup was tested on Intel-based Macs & Apple Silicon Macs On macOS 12 Monterey up to macOS 14 Sonoma

What is this?

The macOS Scripted Setup is perfect for users who want to save time and avoid the hassle of manually changing settings and installing apps. The whole project, but particularly the configuration file, is portable - so you can keep them on a USB-stick for the next Mac setup. Give it a try and streamline your new Mac setup process!

The script is easy to use and can be run directly from the Terminal application, as a regular user or admin user. It automatically performs a series of commands to change default macOS settings and download applications. It's designed to be widely backward and forward compatible with various macOS versions.

All settings can be configured. Some features include enabling the firewall, setting better security features, customising the Finder, Dock, and Mission Control for better productivity; and many more. Additionally, the script installs applications such as browsers, media players, productivity apps, and web development tools.

What is being done exactly?

See what features, settings, and applications can be changed / installed

The script can change the following settings:

FileVault, macOS Firewall, Mission Control, Control Centre, Finder, Dock, git, SSH Key, adds Userhome folders, Menu bar clock, Fast User Switching, and more.

…and is capable of installing these Apps:

Some Apps are downloaded from the official websites, other are added through Homebrew or its Mac App Store CLI extension.

1Password, AlDente, Beyond Compare, Boop, Brave, Composer, Discord, Docker, eqMac, Fig, Firefox, Fork, GasMask, Git, Google Chrome, Homebrew, Keka, LinearMouse, MAMP, Nova, Pixelmator Pro, Quick Look plugins, Rosetta 2, Safari extensions, Sequel Ace, SonarQube, Spotify, Steam, Strongbox, Telegram, Transmission, Tresorit, Warp, Xcode Command Line Tools, Xnapper, and more.

How to use

📥 Download macOS Scripted Setup

Automatic download with this command in the Terminal.app from Applications » Utilities:

curl -SL "https://github.com/Swiss-Mac-User/macOS-scripted-setup/archive/refs/heads/installer.zip" | tar xz -C "$HOME/Downloads" && open "$HOME/Downloads/macOS-scripted-setup-installer"

→ Alternatively you can manually download & extract the latest «Source code (zip)» from Releases to your ~/Downloads/ folder.

⚙️ Configure your preferences

Duplicate the file config.default.sh as config.sh
Open config.sh in a Text editor (e.g. TextEdit.app)
…and change all settings to your personal preferences, using true/false.

Warning

If no config.sh-file is present, the setup will use the default configs from config.default.sh!

Advanced settings

Configuring custom bash commands to run

If you want to run additional bash commands as part of the setup, you can duplicate the template-file mycommands.template.sh as mycommands.sh, and populate it with any commands. These custom commands will be executed LAST in the whole setup (see the run.sh file).

🚀 Start the scripted Setup

Maybe now is the time to grab a coffee ☕️…

Open the «Terminal.app» from Applications » Utilities
Paste the following command to the Terminal.app:

cd ~/Downloads/macOS-scripted-setup-installer/ && chmod +x ./run.sh && ./run.sh

Now start the setup by pressing Return & watch the magic happen…

Tip

Occasionally you have to interact when instructions show up, such as to sign-in on the Mac App Store.

✨ That's it - happy installation! :)

Requests for changes

Issues and feature requests

Report an Issue or start a new Discussion for feedback or help.

Contributions

Feel free to fork this project and add Pull Requests for any suggested changes or additions!

Inspiration and Kudos

A BIG «THANK YOU» to these inspiring and helfpful sources! 🫶 Make sure to check them out and leave a kudos.

Yann Bertrand's awesome work with «macOS-defaults»
Patrick Force's approach with «macOSa» (which was a bit too complex for my use case…)
Ryan Pavlick's helpful «add_to_dock» bash scripts
Mathias Bynens's epic «dotfiles» (particularly its .macos)!
Big KUDOS to «Homebrew» and the «Mac App Store command line interface»! 👏
MacRumors «Dock to Show Running Apps Only», Ask Different «identify if Filevault is enabled» and «Check if OS X user is Administrator»

macos-scripted-setup's People

Contributors

Stargazers

Watchers

macos-scripted-setup's Issues

[Known issue] `mas` (Mac App Store CLI) not installing Apps in macOS 12+

The Homebrew extension mas (Mac App Store command line interface), for automatic Apps install from the Mac App Store, won't recognize a successful App Store-authentication during setup.

Reason is the known issue and lacking support by the mas library itself, as tracked in the issue here:

mas-cli/mas#417

Workaround

Note that mas will be successfully installed (if enabled), and hence can later be used in the Terminal to manually install Apps from the Mac App Store.

[Help wanted] macOS 14 Sonoma support

Any feedbacks for macOS 14 Sonoma support is highly appreciated.

[Applications] Remove Fig – it's sunsetting

Remove support for «Fig», as it's officially being discontinued.

Remove /Applications/Fig.sh
Remove install switch from config.default.sh

[Known issue] «App is damaged and can’t be opened» error when opening downloaded Apps

Some Applications downloaded by the script and using curl will, when trying to be (automatically) be opened, show the warning:

«App is damaged and can’t be opened. You should move it to the bin.»

Root cause

macOS security (Gatekeeper) quarantines some Apps, in order to attempt to limit software to the Mac App Store - plus System Integrity Protection is preventing third-party apps from potentially tampering with sensitive parts of the system or injecting code into Apple apps like Finder and Safari.

Unfortunately, at least since macOS 13 Ventura (which tightens security and previous workarounds), my tests were all unsuccessful to programmatically remove the affected Apps out of the Gatekeeper quarantine: I tried removing xattr-attributes, temporarily disabling spctl, and assigning missing xattr-attributes about the downloaded datetime and source.

Hence I see this currently as a won't fix - unless someone finds a clever way how this protection could be circumvented.

Workaround

As the apps are downloaded via their official website, it's unlikely – but not guaranteed – they are expected to be non-malicious and a so called "false positive".

The Apps can be opened using the following manual steps:

Right-click the Application and choose "Open"
Confirm the additional warning shown

Affected applications

Affected applications are:

Keka
Transmission
Nova
(non conclusive)

Not affected Apps seem to be:

1Password Installer
Spotify Installer
Gas Mask
(non conclusive)

swiss-mac-user / macos-scripted-setup Goto Github PK

macos-scripted-setup's Introduction

Automate your macOS setup

What is this?

What is being done exactly?

The script can change the following settings:

…and is capable of installing these Apps:

How to use

📥 Download macOS Scripted Setup

⚙️ Configure your preferences

Advanced settings

🚀 Start the scripted Setup

✨ That's it - happy installation! :)

Requests for changes

Issues and feature requests

Contributions

Inspiration and Kudos

macos-scripted-setup's People

Contributors

Stargazers

Watchers

Forkers

macos-scripted-setup's Issues

Workaround

Root cause

Workaround

Affected applications

Recommend Projects

Recommend Topics

Recommend Org