Skip to content

Latest commit

 

History

History
539 lines (444 loc) · 22.5 KB

README.md

File metadata and controls

539 lines (444 loc) · 22.5 KB
Raw

new-mac-setup

gitmoji pre-commit

A clean setup of Mac OS X 10.15 for Python development and more

For personal & professional use.

Notes

  • Avoid committing secrets into this repo by running pre-commit install in this dir.
  • Want to copy a big dir from an old Mac? Below is brew install rsync! It's much faster than Finder's copying util. 
    # boot old Mac while holding `T` to go in Target Disk Mode
# password prompt should pop up
rsync -au --progress <drag src folder> ~/backup
  • Don't forget to take with your whole .gnupg folder, .gitconfig, .envrc etc!
  • Chrome settings/bookmarks are not backed up and are assumed to come from its builtin Sync.

Tech Stack

Mac Look and Feel

# Do you understand zsh internals? I don't.
chsh -s /bin/bash && reset
# show hidden files (finder restart needed)
defaults write com.apple.finder AppleShowAllFiles YES
# disable google chrome dark mode when Mojave dark mode is enabled
defaults write com.google.Chrome NSRequiresAquaSystemAppearance -bool yes
Apple look & feel optimisations

  • System Preferences/General/
    • Show scroll bars: Always
    • Click in the scroll bar to: Jump to the spot that's clicked
    • Recent items: 50
  • System Preferences/Keyboard/
    • Slide Key Repeat to Fast
    • Slide Delay Until Repeat to tick one before Short
    • Under Text, untick/remove everything
    • Under Shortcuts, tick Use keyboard navigation to move focus between controls on the bottom
    • Under Input Sources, set keyboard layout to U.S. (remove U.S. International)
    • Under Touch Bar shows, choose Expanded Control Strip
  • System Preferences/Security & Privacy/
    • Under FileVault, turn on FileVault
  • System Preferences/Accessibility/
    • Under Zoom, tick Use scroll gesture with modifier keys to zoom:
    • Under Display, untick Shake mouse pointer to locate
    • Under Mouse & Trackpad/Trackpad Options..., tick Enable dragging/three finger drag
  • System Preferences/Trackpad/
    • Under Point & Click, ticks 0, 1, 1, 0, Click Medium
    • Under Scroll & Zoom, ticks 0, 1, 0, 1
    • Under Scroll & Zoom, ticks 0, 1, 1, 1, 1, 1, 1, everything four fingers
  • System Preferences/Software Update/
    • Under Advanced..., untick Download new updates when available
  • System Preferences/Dock/
    • Untick Show recent applications in Dock
    • Tick Turn Hiding On
  • Finder preferences
    • General
      • New Finder windows show: home
    • Advanced
      • Tick Show all filename extensions
      • When performing a search: Search the Current Folder
  • Finder View Options (go home: ⌘⇧H, then ⌘J)
    • Tick Always open in List View
      • Tick Browse in List View
    • Group by: None
    • Sort by: Name
    • Tick Calculate all sizes
    • Tick Show Library Folder
    • Click Use as Defaults
  • Finder View menu item
    • Show Tab Bar
    • Show Path Bar
    • Show Status Bar
  • TextEdit preferences
    • New Document
      • Format: Plain text
      • Untick Check spelling as you type
    • Open and Save
      • Untick Add ".txt" extension to plain text files
      • Under Plain Text File Encoding, select two times UTF-8
  • Screenshot Options (to open: ⌘⇧5)
    • Untick Show Floating Thumbnail

Terminal Look and Feel

Homebrew and its essentials

# install homebrew (which installs command-line tools)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
brew tap homebrew/cask
brew tap buo/cask-upgrade  # `brew cu -a docker` - https://github.com/buo/homebrew-cask-upgrade#usage
# check whether all is good
brew doctor

# and some essentials
# - ruby, gcc-8 are linked in `.bash_profile`
# - node@14 (LTS at time of writing) installs npm
brew install \
  git git-lfs gitmoji bash-completion rsync curl openssl readline automake xz zlib \
  osxfuse sshfs htop ncdu direnv pwgen \
  gcc@8 rust ruby node@14 sqlite3
# check out caveats from command above!
# npm installs yarn
PATH="/usr/local/opt/node@14/bin:$PATH" npm install -g yarn

iTerm nerd font

brew install --cask iterm2
brew install --cask homebrew/cask-fonts/font-inconsolata-lgc-nerd-font

# some blazing fast rust
cargo install ripgrep  # rg (search for regex occurrences in directory, fastest regex implementation in the world)
cargo install zoxide  # z (cd with auto-complete) - echo 'eval "$(zoxide init bash)"' > ~.bash_profile
brew install zenith # fancy htop with persistent network and disk I/O history graphs
cargo install --git https://github.com/ogham/exa.git  # crates.io is heavily outdated at time of writing
cargo install tealdeer  # rust implementation of tldr (man for lazy people)
tldr --update  # populate cache
# use exa with icons and git status instead of builtin ls
# this is in .bash_profile already
alias ls="exa --all --group-directories-first --icons --level=2"  # default level for --tree
alias ll="ls --long --sort=age --git --time=modified --time-style=iso"

Casks

# Docker CE - docker.com/community-edition - Open Docker.app manually to install helper and to enable CLI
brew install --cask docker
brew install docker-compose
# Sublime Text - sublimetext.com
brew install --cask sublime-text
# Sublime Merge - sublimemerge.com
brew install --cask sublime-merge
# Google Chrome - google.com/chrome
brew install --cask google-chrome
# PIA VPN - privateinternetaccess.com - Requires manual install from ~/Library/Caches/Homebrew/downloads
brew install --cask private-internet-access
# Tunnelblick OpenVPN - tunnelblick.net
brew install --cask tunnelblick
# The Unarchiver - theunarchiver.com
brew install --cask the-unarchiver
# f.lux - justgetflux.com - In Preferences/Sessions, tick 'Allow Dispklay Sleep'
brew install --cask flux
# VLC - videolan.org/vlc
brew install --cask vlc
# Slack - slack.com
# brew install --cask slack
# Zoom.us - zoom.us
brew install --cask zoom
# Whatsapp - whatsapp.com
# brew install --cask whatsapp
# Dropbox - dropbox.com
# brew install --cask dropbox
# Authy - authy.com - Set Master Password in preferences after init
brew install --cask authy
# Jitsi Meet - jit.si
brew install --cask jitsi-meet
# Maccy - maccy.app
brew install --cask maccy
# pdflatex - tug.org/mactex/
brew install --cask mactex-no-gui

Mac App Store (MAS)

When launching apps for the first time, you might have to accept the dev under System Preferences/Security & Privacy/General

Note: mas will not allow you to install (or even purchase) an app for the first time: it must already be in the Purchased tab of the App Store.

brew install mas
# iStat Menus - bjango.com/mac/istatmenus
mas install 1319778037
# Magnet - magnet.crowdcafe.com
mas install 441258766
# DaisyDisk - daisydiskapp.com
# give full disk access under sysprefs security tab
mas install 411643860
# Amphetamine - roaringapps.com/app/amphetamine
mas install 937984704
# Telegram - macos.telegram.org - set password and enter behaviour after init
mas install 747648890

Backups

Note: first open Chrome for the first time

  • Clone (a fork of) this repo and set things up 
    mkdir ~/git
git clone https://github.com/ddelange/new-mac-setup.git ~/git/new-mac-setup
ln -s ~/git/new-mac-setup/.bash_profile ~/.bash_profile && source ~/.bash_profile
mkdir -p ~/.config/htop && ln -s ~/git/new-mac-setup/htoprc ~/.config/htop/htoprc
direnv edit ~  # add `export SECRET=42` to load global env vars  # pragma: allowlist secret

# Sublime Text 3 backup
# restore
mkdir -p "${HOME}/Library/Application Support/Sublime Text 3/Packages/User" && \
    rsync -a "${HOME}/git/new-mac-setup/sublime_text_user_settings/" "${HOME}/Library/Application Support/Sublime Text 3/Packages/User"

# create
rsync -a "${HOME}/Library/Application Support/Sublime Text 3/Packages/User/" "${HOME}/git/new-mac-setup/sublime_text_user_settings"

# Chrome search engines backup
# restore
sqlite3 "${HOME}/Library/Application Support/Google/Chrome/Default/Web Data" < ./search-engine-export.sql
# create
(printf 'begin transaction;\n'; sqlite3 "${HOME}/Library/Application Support/Google/Chrome/Default/Web Data" 'select short_name,keyword,url,favicon_url from keywords' | awk -F\| '{ printf "REPLACE INTO keywords (short_name, keyword, url, favicon_url) values ('"'"%s"'"', '"'"%s"'"', '"'"%s"'"', '"'"%s"'"');\n", $1, $2, $3, $4 }'; printf 'end transaction;\n') > ./search-engine-export.sql
  • iTerm2 preferences: under General/Preferences, tick Load preferences from a custom folder or URL and paste ~/git/new-mac-setup. Quit iTerm
  • iStat Menus preferences: File/Import Settings..., select iStat Menus Settings.ismp. Drag & drop menu bar items with ⌘+drag
  • Quickly download audio & video with yt 
    brew install ddelange/brewformulae/yt

pyenv and pyenv-virtualenv

  • Note: pyvenv-virtualenv needs to be initialised in ~/.bash_profile, or in ~/.bashrc if both files are maintained separately: 
    eval "$(pyenv init -)"
if which pyenv-virtualenv-init > /dev/null; then eval "$(pyenv virtualenv-init -)"; fi
  • Set up latest Python versions 
    brew install pyenv pyenv-virtualenv
# get your favourite python versions - github.com/momo-lab/pyenv-install-latest
git clone https://github.com/momo-lab/pyenv-install-latest.git "$(pyenv root)"/plugins/pyenv-install-latest
git clone git://github.com/concordusapps/pyenv-implict.git "$(pyenv root)"/plugins/pyenv-implict
pyenv install -l | grep '^\s*[0-9]' # list all available python versions
pyenv install-latest 2
pyenv install-latest 3
pyenv versions  # see currently installed versions
pyenv global $(pyenv install-latest --print 3) $(pyenv install-latest --print 2)  # set default versions: prefer py3 over py2
# install virtualenv 'vv' based latest pyenv Python version 3.x, inheriting installed packages
pyenv virtualenv $(pyenv install-latest --print 3) --system-site-packages vv
# same for 'vv27' with python 2.7.x
pyenv virtualenv $(pyenv install-latest --print 2) --system-site-packages vv27
  • Manage envs 
    pyenv virtualenvs
pyenv virtualenv --system-site-packages <venv-name>
pyenv activate <venv-name>
pyenv deactivate
pyenv uninstall <venv-name>

Git with 2FA

Enable and set up 2FA. It's recommended to first delete any git configurations locally after enabling 2FA.

  • Use built-in keychain and app password from above, and add a Mac specific global gitignore: 
    git config --global user.name "ddelange"
git config --global user.email "[email protected]"  # fetch this from https://github.com/settings/emails
git config --global credential.helper osxkeychain

# EITHER
curl -sLw "\n" "http://gitignore.io/api/macos,python,django,sublimetext" >> ~/.gitignore  # for all possibilities see http://gitignore.io/api/list
# OR
cp .gitignore.global ~/.gitignore

git config --global core.excludesfile "~/.gitignore"
  • Note: it's advised to add commit signature verification to Git.
  • Generate a GPG key and tell Git to use it: 
    brew install gpg
gpg --full-generate-key  # recommended settings: enter, 4096, enter
gpg --list-secret-keys --keyid-format LONG  # copy the key after 'sec  4096R/'
gpg --armor --export <key-here>  # paste this key at github.com/settings/keys
git config --global user.signingkey <key-here>
git config --global commit.gpgsign true
git config --global gpg.program "$(which gpg)"
# sign tags using git tag -s
  • To enable password caching for 1 week: 
    echo "default-cache-ttl 604800" >> ~/.gnupg/gpg-agent.conf
echo "max-cache-ttl 604800" >> ~/.gnupg/gpg-agent.conf
echo "log-file /var/log/gpg-agent.log" >> ~/.gnupg/gpg-agent.conf
Mac OSX specifics
git config --global pull.rebase false
git config --global core.trustctime false  # http://www.git-tower.com/blog/make-git-rebase-safe-on-osx
git config --global core.precomposeunicode false  # http://michael-kuehnel.de/git/2014/11/21/git-mac-osx-and-german-umlaute.html
git config --global core.untrackedCache true  # https://git-scm.com/docs/git-update-index#_untracked_cache
git config --global merge.log true  # Include summaries of merged commits in newly created merge commit messages
git config --global push.default "simple" # https://git-scm.com/docs/git-config#Documentation/git-config.txt-pushdefault
git config --global push.followTags true # https://git-scm.com/docs/git-config#Documentation/git-config.txt-pushfollowTags
git config --global init.defaultBranch master
Aliases

Some of these aliases depend on one another, in which case it's noted in the comments.

Shorthands
git config --global alias.br "branch"
git config --global alias.ca "commit -am"
git config --global alias.cm "commit"
git config --global alias.co "checkout"
git config --global alias.mt "mergetool"
git config --global alias.st "status"
# split diff - needs icdiff (see below) - use `git icdiff` to keep output in terminal after less quits
git config --global alias.df '! f() { diff=$(git difft "$@") && test "$diff" && echo "$diff" | less -eR; }; f'
# who needs the default verbose git log? - also try `git lg --all`
git config --global alias.lg "log --graph --oneline"
# tested with GitHub remote - ref https://stackoverflow.com/questions/28666357#comment101797372_50056710
git config --global alias.defaultbranch '! f() { echo $(git remote show origin | grep "HEAD branch" | cut -d ":" -f 2 | xargs); }; f'
# summary of all configured aliases
git config --global alias.alias "! git config --get-regexp '^alias\.' | sed -e s/^alias\.// | grep -v ^'alias ' | sed 's/ /#/' | column -ts#"
# "commit all & push" - needs ca,pr - usage `git cap 'Fix bug'` - runs autoformatting pre-commit hooks, commits all modified tracked files with message, and push
git config --global alias.cap '! f() { git ca "$@" && git pr; }; f'
# "pull request" - push new or existing branch skipping the usual --set-upstream error - alias will be overwritten when git-extras is installed
git config --global alias.pr '! git push --set-upstream origin "$(git rev-parse --abbrev-ref HEAD)"'
Cleaning
# "delete merged" - delete all local branches (-D) that have been deleted (merged) on remote
git config --global alias.dm '! git fetch -p && for branch in `git branch -vv | grep '"': gone] ' | awk '"'{print $1}'"'"'`; do git branch -D $branch; done'
# "fetch purge" - before fetching, remove any remote-tracking references that no longer exist on the remote
git config --global alias.fp "fetch -p --all"
# "rinse & repeat" - needs defaultbranch,dm - usage `git gg [develop]` - return to default branch (or specified branch), delete merged and pull
git config --global alias.gg '! f() { git checkout "${1:-$(git defaultbranch)}" && git dm && git pull; }; f'
# "pull all" - pull all local branches and return to original branch
git config --global alias.pall '! f() { \
START=$(git branch | grep "\*" | sed "s/^.//"); \
for i in $(git branch | sed "s/^.//"); do \
  git checkout $i; \
  git pull || break; \
done; \
git checkout $START; \
}; f'
Rewriting history
# "commit all amend" last commit, adding all modified tracked files to the it without editing the commit message
git config --global alias.amend "commit --amend --reset-author --no-edit -a"
# "commit all amend with message" - add all modified tracked files to the last commit with a new commit message
git config --global alias.camend "commit --amend --reset-author -am"
# "squash last" X commits - allowing to edit a pre-generated commit message before committing - known caveat: when trying to squash into an initial commit, the reset fails
git config --global alias.squashlast '!f(){ git reset --soft HEAD~${1} && git commit --edit -m\"$(git log --format=%B --reverse HEAD..HEAD@{1})\"; };f'
# "undo" whatever you did last, for instance an erroneous squashlast - ref https://megakemp.com/2016/08/25/git-undo/
git config --global alias.undo '! f() { git reset --hard $(git rev-parse --abbrev-ref HEAD)@{${1-1}}; }; f'
Split diff
  • git df (above) uses less that keeps a clean terminal
  • git icdiff and git difft (below) uses new core.pager that leaves less output in terminal after exiting
git config --global --replace-all core.pager 'less -+$LESS -eFRSX'  # with double quotes, $ will be evaluated

# with diff highlighting
pip install git+https://github.com/jeffkaufman/icdiff.git  # installs git-icdiff for `git icdiff``
git config --global icdiff.options "--highlight --line-numbers --numlines=3 --color=always"
git config --global difftool.icdiff.cmd 'icdiff --highlight --line-numbers --numlines=3 --color=always $LOCAL $REMOTE'

# with syntax & diff highlighting
brew install difftastic
git config --global difftool.difft.cmd 'difft --display=side-by-side-show-both --color=always --background=light "$LOCAL" "$REMOTE"'
git config --global alias.difft 'difftool --tool difft --no-prompt'
Mergetool

On failed automatic merge, use Sublime Merge GUI for conflict resolution using git mergetool or git mt (see above).

git config --global mergetool.smerge.cmd 'smerge mergetool "$BASE" "$LOCAL" "$REMOTE" -o "$MERGED"'
git config --global mergetool.smerge.trustExitCode true
git config --global mergetool.keepBackup false
git config --global merge.tool smerge

Cleanup (different options)

brew cleanup --prune=0  # delete cache older than 0 days

Keyboard Shortcuts

  • Sublime
    • s, smerge
    • line selctors: ⌘L, ⌘⇧L
    • swap lines: ⌃⌘↑/↓
    • swap selection shortcut TODO
  • forward delete (⌦): fn⌫ or ^D
  • cutpaste files: ⌘⌥V
  • lock machine: ⌘⇧Q
  • spotlight: ⌘␣
  • screenshots: ⌘⇧3/4/5 and one window: ⌘⇧4, then ␣
  • restore tab: ⌘⇧T
  • ^↑/↓
  • ⌘~ or ⌘` to switch windows
  • ~. to stop ssh
  • emoji chooser: ⌘^␣
  • the shortcut-changing prefpane
Full Keyboard Symbol List

  • ⌘ is command

  • ⌥ is option

  • ⌃ is control

  • ⇧ is shift

  • ⇪ is caps lock

  • ← is left arrow

  • → is right arrow

  • ↑ is up arrow

  • ↓ is down arrow

  • ⇥ is tab

  • ⇤ is backtab

  • ↩ is return

  • ⌤ is enter

  • ⌫ is delete
/backspace
  • ⌦ is forward delete

  • ⇞ is page up

  • ⇟ is page down

  • ↖ is home

  • ↘ is end

  • ⌧ is clear

  • ␣ is space

  • ⎋ is escape

  • ⏏ is eject

Misc

  • To revert to the classic iTunes playlist view from before v12.6:
  • Scroll horizontally using ⇧, then mouse wheel

Kubernetes CLI (kubectl)

Kubectl is a command line interface for running commands against Kubernetes clusters (like viewing logs or executing commands on pods). See kubebash kubelogs kubebranch for plug & play kubectl extensions (they are already in ~/.bash_profile).

Fancy Dropbox screen shot sharing

AppleScript to shorten links using the bitly API in a smart way directly with a keyboard shortcut

Gigabit USB Driver OS X 10.9+

Not needed for 10.15, it is now built-in.

For almost any Gigabit Ethernet USB hub

TODO