Automated Configuration, Preferences and Software Installation for macOS
Vim script Shell JavaScript Ruby
Latest commit bcd206a Feb 10, 2017 @atomantic committed on GitHub Merge pull request #15 from atomantic/4.4.1-rc
4.4.1 rc
Permalink
Failed to load latest commit information.
.git_template/hooks fix optional gitshots Feb 10, 2017
configs allow option of overwriting /etc/hosts with someonewhocares.org file Feb 10, 2017
fonts 3.1.0, improves vim, font install via homebrew cask, etc Jul 6, 2016
homedir disable YouCompleteMe vim bundle Feb 10, 2017
img adding vtop alias with theme and new term image May 25, 2016
lib_node HUGE 3.0.0 breaking changes. Using node.js to install sofware and reo… May 25, 2016
lib_sh HUGE 3.0.0 breaking changes. Using node.js to install sofware and reo… May 25, 2016
oh-my-zsh @ 9ad9ac6 fix github user replacement May 25, 2016
z-zsh @ 052a6cb really adding submodules :) May 24, 2012
.editorconfig HUGE 3.0.0 breaking changes. Using node.js to install sofware and reo… May 25, 2016
.eslintrc HUGE 3.0.0 breaking changes. Using node.js to install sofware and reo… May 25, 2016
.gitignore HUGE 3.0.0 breaking changes. Using node.js to install sofware and reo… May 25, 2016
.gitmodules HUGE 3.0.0 breaking changes. Using node.js to install sofware and reo… May 25, 2016
CODE_OF_CONDUCT.md markdown preview, update readme, history, etc Apr 28, 2016
HISTORY.md fix optional gitshots Feb 10, 2017
LICENSE.md fixes #3 Jul 9, 2015
README.md no longer disable notification center Feb 10, 2017
config.js make gitshots optional Feb 10, 2017
index.js make gitshots optional Feb 10, 2017
install.sh no longer disable notification center Feb 10, 2017
package.json no longer disable notification center Feb 10, 2017
restore.sh fix iterm colors Sep 14, 2016

README.md

Beerpay

\[._.]/ - Hi, I'm the MacOS bot

I will update your MacOS machine with Better™ system defaults, preferences, software configuration and even auto-install some handy development tools and apps that my developer friends find helpful.

You don't need to install or configure anything upfront! This works with a brand-new machine from the factory as well as an existing machine that you've been working with for years.

Forget About Manual Configuration!

Don't you hate getting a new laptop or joining a new team and then spending a whole day setting up your system preferences and tools? Me too. That's why we automate; we did it once and we don't want to do have to do it again.

\[^_^]/ - This started as Adam Eivy's MacOS shell configuration dotfiles but has grown to a multi-developer platform for machine configuration.

When I finish with your machine, you will be able to look at your command-line in full-screen mode like this (running iTerm):

iTerm Screenshot

Check out how your shell prompt includes the full path, node.js version & the working git branch along with a lot of other info! We use powerlevel9k for command prompt, so customization of what you want is easily changable in ./.zshrc The top terminal is using vim + NerdTree as a full Atom replacement IDE. The bottom left two are git terminals. The bottom right is running vtop

To launch fullscreen, hit Command + Enter in iTerm, then use Command + d and Command + D to create split panes.

\[._.]/ - I'm so excited I just binaried in my pants!

Watch me run!

Running

Installation

Note: I recommend forking this repo in case you don't like anything I do and want to set your own preferences (and pull request them!)

REVIEW WHAT THIS SCRIPT DOES PRIOR TO RUNNING: https://github.com/atomantic/dotfiles/blob/master/install.sh#L275-L1038 It's always a good idea to review arbitrary code from the internet before running it on your machine with sudo power! You are responsible for everything this script does to your machine (see LICENSE)

git clone --recurse-submodules https://github.com/atomantic/dotfiles ~/.dotfiles
cd ~/.dotfiles;
# run this using terminal (not iTerm, lest iTerm settings get discarded on exit)
./install.sh
  • When it finishes, open Iterm and press Command + , to open preferences. Under Profiles > Colors, select "Load Presets" and choose the Solarized Dark Patch scheme. If it isn't there for some reason, import it from ~/.dotfiles/configs -- you may also need to select the Hack font and check the box for non-ascii font and set to Roboto Mono For Powerline (I've had mixed results for automating these settings--love a pull request that improves this)
  • I've also found that you need to reboot before fast key repeat will be enabled

Note: running install.sh is idempotent. You can run it again and again as you add new features or software to the scripts! I'll regularly add new configurations so keep an eye on this repo as it grows and optimizes.

Restoring Dotfiles

If you have existing dotfiles for configuring git, zsh, vim, etc, these will be backed-up into ~/.dotfiles_backup/$(date +"%Y.%m.%d.%H.%M.%S") and replaced with the files from this project. You can restore your original dotfiles by using ./restore.sh $RESTOREDATE where $RESTOREDATE is the date folder name you want to restore.

The restore script does not currently restore system settings--only your original dotfiles. To restore system settings, you'll need to manually undo what you don't like (so don't forget to fork, review, tweak)

3.x.x+ Upgrade Instructions!

3.0.0 brings huge changes. If you have made any modifications (and didn't make your own fork), you will want to backup your dotfiles prior to running git-up or git pull on ~/.dotfiles.

Do the following to upgrade your ~/.dotfiles safely:

  1. backup your dotfiles: cp -R ~/.dotfiles ~/.dotfiles_old
  2. cd ~/.dotfiles
  3. update dotfiles: git-up or git pull
  4. remove old submodule location: rm -rf .vim (now lives in homedir/.vim)
  5. inspect install.sh and config.js to make sure all the software you want is installed
  6. inspect homedir/* for any changes you want to port from ./dotfiles_old
  7. run install.sh again

Additional

VIM as IDE

I am moving away from using Atom and instead using vim as my IDE. I use Vundle to manage vim plugins (instead of pathogen). Vundle is better in many ways and is compatible with pathogen plugins. Additionally, vundle will manage and install its own plugins so we don't have to use git submodules for all of them.

Crontab

You can cron ~/.crontab if you want to add my nightly cron software updates.

\[0_0]/ - Note that this may wake you in the morning to compatibility issues so use only if you like being on the edge

Remap Caps-Lock

  • I highly recommend remapping your Caps Lock key to Control per Dr. Bunsen: Remap Caps Lock

Settings

This project changes a number of settings and configures software on MacOS. Here is the current list:

Prompt Driven Configuration

The following will only happen if you agree on the prompt

  • install a gitshots script to take a photo using your camera on every git commit (these go in as a post-commit hook to your .git_template)
  • overwrite your /etc/hosts file with a copy from someonewhocares.org (see ./configs/hosts for the file that will be used)
  • replace the system wallpaper with img/wallpaper.jpg

SSD-specific tweaks

  • Disable local Time Machine snapshots
  • Disable hibernation (speeds up entering sleep mode)
  • Remove the sleep image file to save disk space

General System Changes

  • always boot in verbose mode (not MacOS GUI mode)
  • Disable the sound effects on boot
  • Menu bar: disable transparency
  • Menu bar: hide the Time Machine, Volume, User, and Bluetooth icons
  • Set highlight color to green
  • Set sidebar icon size to medium
  • Always show scrollbars
  • Increase window resize speed for Cocoa applications
  • Expand save panel by default
  • Expand print panel by default
  • allow 'locate' command
  • Set standby delay to 24 hours (default is 1 hour)
  • Save to disk (not to iCloud) by default
  • Automatically quit printer app once the print jobs complete
  • Disable the “Are you sure you want to open this application?” dialog
  • Remove duplicates in the “Open With” menu (also see 'lscleanup' alias)
  • Display ASCII control characters using caret notation in standard text views
  • Disable automatic termination of inactive apps
  • Disable the crash reporter
  • Set Help Viewer windows to non-floating mode
  • Reveal IP, hostname, OS, etc. when clicking clock in login window
  • Restart automatically if the computer freezes
  • Never go into computer sleep mode
  • Check for software updates daily, not just once per week
  • Disable smart quotes as they’re annoying when typing code
  • Disable smart dashes as they’re annoying when typing code

Security

  • Enable firewall
  • Enable firewall stealth mode (no response to ICMP / ping requests)
  • Disable remote apple events
  • Disable wake-on modem
  • Disable wake-on LAN
  • Disable guest account login

Trackpad, mouse, keyboard, Bluetooth accessories, and input

  • Trackpad: enable tap to click for this user and for the login screen
  • Trackpad: map bottom right corner to right-click
  • Disable “natural” (Lion-style) scrolling
  • Increase sound quality for Bluetooth headphones/headsets
  • Enable full keyboard access for all controls (e.g. enable Tab in modal dialogs)
  • Use scroll gesture with the Ctrl (^) modifier key to zoom
  • Follow the keyboard focus while zoomed in
  • Disable press-and-hold for keys in favor of key repeat
  • Set a blazingly fast keyboard repeat rate:
  • Set language and text formats (english/US)
  • Disable auto-correct

Configuring the Screen

  • Require password immediately after sleep or screen saver begins
  • Save screenshots to the desktop
  • Save screenshots in PNG format (other options: BMP, GIF, JPG, PDF, TIFF)
  • Disable shadow in screenshots
  • Enable subpixel font rendering on non-Apple LCDs
  • Enable HiDPI display modes (requires restart)

Finder Configs

  • Keep folders on top when sorting by name (Sierra only)
  • Allow quitting via ⌘ + Q; doing so will also hide desktop icons
  • Disable window animations and Get Info animations
  • Set Desktop as the default location for new Finder windows
  • Show hidden files by default
  • Show all filename extensions
  • Show status bar
  • Show path bar
  • Allow text selection in Quick Look
  • Display full POSIX path as Finder window title
  • When performing a search, search the current folder by default
  • Disable the warning when changing a file extension
  • Enable spring loading for directories
  • Remove the spring loading delay for directories
  • Avoid creating .DS_Store files on network volumes
  • Disable disk image verification
  • Automatically open a new Finder window when a volume is mounted
  • Use list view in all Finder windows by default
  • Disable the warning before emptying the Trash
  • Empty Trash securely by default
  • Enable AirDrop over Ethernet and on unsupported Macs running Lion
  • Show the ~/Library folder
  • Expand the following File Info panes: “General”, “Open with”, and “Sharing & Permissions”

Dock & Dashboard

  • Enable highlight hover effect for the grid view of a stack (Dock)
  • Set the icon size of Dock items to 36 pixels
  • Change minimize/maximize window effect to scale
  • Minimize windows into their application’s icon
  • Enable spring loading for all Dock items
  • Show indicator lights for open applications in the Dock
  • Don’t animate opening applications from the Dock
  • Speed up Mission Control animations
  • Don’t group windows by application in Mission Control
  • Disable Dashboard
  • Don’t show Dashboard as a Space
  • Don’t automatically rearrange Spaces based on most recent use
  • Remove the auto-hiding Dock delay
  • Remove the animation when hiding/showing the Dock
  • Automatically hide and show the Dock
  • Make Dock icons of hidden applications translucent
  • Make Dock more transparent
  • Reset Launchpad, but keep the desktop wallpaper intact

Configuring Hot Corners

  • Top left screen corner → Mission Control
  • Top right screen corner → Desktop
  • Bottom right screen corner → Start screen saver

Configuring Safari & WebKit

  • Set Safari’s home page to ‘about:blank’ for faster loading
  • Prevent Safari from opening ‘safe’ files automatically after downloading
  • Allow hitting the Backspace key to go to the previous page in history
  • Hide Safari’s bookmarks bar by default
  • Hide Safari’s sidebar in Top Sites
  • Disable Safari’s thumbnail cache for History and Top Sites
  • Enable Safari’s debug menu
  • Make Safari’s search banners default to Contains instead of Starts With
  • Remove useless icons from Safari’s bookmarks bar
  • Enable the Develop menu and the Web Inspector in Safari
  • Add a context menu item for showing the Web Inspector in web views

Configuring Mail

  • Disable send and reply animations in Mail.app
  • Copy email addresses as 'foo@example.com' instead of 'Foo Bar foo@example.com' in Mail.app
  • Add the keyboard shortcut ⌘ + Enter to send an email in Mail.app
  • Display emails in threaded mode, sorted by date (oldest at the top)
  • Disable inline attachments (just show the icons)
  • Disable automatic spell checking

Spotlight

  • Disable Spotlight indexing for any volume that gets mounted and has not yet been indexed
  • Change indexing order and disable some file types from being indexed
  • Load new settings before rebuilding the index
  • Make sure indexing is enabled for the main volume

iTerm2

  • Installing the Solarized Dark theme for iTerm
  • Don’t display the annoying prompt when quitting iTerm
  • Hide tab title bars
  • Set system-wide hotkey to show/hide iterm with ctrl+tick ( ^ + `)
  • Set normal font to Hack 12pt
  • Set non-ascii font to Roboto Mono for Powerline 12pt

Time Machine

  • Prevent Time Machine from prompting to use new hard drives as backup volume
  • Disable local Time Machine backups

Activity Monitor

  • Show the main window when launching Activity Monitor
  • Visualize CPU usage in the Activity Monitor Dock icon
  • Show all processes in Activity Monitor
  • Sort Activity Monitor results by CPU usage

Address Book, Dashboard, iCal, TextEdit, and Disk Utility

  • Enable the debug menu in Address Book
  • Enable Dashboard dev mode (allows keeping widgets on the desktop)
  • Use plain text mode for new TextEdit documents
  • Open and save files as UTF-8 in TextEdit
  • Enable the debug menu in Disk Utility

Mac App Store

  • Enable the WebKit Developer Tools in the Mac App Store
  • Enable Debug Menu in the Mac App Store

Messages

  • Disable automatic emoji substitution (i.e. use plain text smileys)
  • Disable smart quotes as it’s annoying for messages that contain code
  • Disable continuous spell checking

SizeUp.app

  • Start SizeUp at login
  • Don’t show the preferences window on next start

Software Installation

homebrew, fontconfig, git, ruby (latest), nvm (node + npm), and zsh (latest) are all installed inside the install.sh as foundational software for running this project. Additional software is configured in config.js and can be customized in your own fork/branch (you can change everything in your own fork/brance). The following is the software that I have set as default:

Utilities

  • ack
  • ag
  • coreutils
  • dos2unix
  • findutils
  • fortune
  • gawk
  • gifsicle
  • gnupg
  • gnu-sed
  • homebrew/dupes/grep
  • httpie
  • imagemagick (only if gitshots enabled)
  • imagesnap (only if gitshots enabled)
  • jq
  • mas
  • moreutils
  • nmap
  • openconnect
  • reattach-to-user-namespace
  • homebrew/dupes/screen
  • tmux
  • tree
  • ttyrec
  • vim --override-system-vi
  • watch
  • wget --enable-iri

Apps

  • box-sync
  • gpgtools
  • iterm2
  • sizeup
  • slack
  • the-unarchiver
  • xquartz

NPM Global Modules

  • antic
  • buzzphrase
  • eslint
  • gulp
  • instant-markdown-d
  • npm-check
  • prettyjson
  • trash
  • vtop

Ruby Gems

  • git-up

License

This project is licensed under ISC. Please fork, contribute and share.

Contributions

Contributions are always welcome in the form of pull requests with explanatory comments.

Please refer to the Contributor Covenant

Loathing, Mehs and Praise

  1. Loathing should be directed into pull requests that make it better. woot.
  2. Bugs with the setup should be put as GitHub issues.
  3. Mehs should be > /dev/null
  4. Praise should be directed to @antic

¯\(ツ)/¯ Warning / Liability

Warning: The creator of this repo is not responsible if your machine ends up in a state you are not happy with. If you are concerned, look at the code to review everything this will do to your machine :)