Laptop is a script to set up a macOS laptop for web and mobile development.
It can be run multiple times on the same machine safely. It installs, upgrades, or skips packages based on what is already installed on the machine.
We support:
- macOS Mavericks (10.9)
- macOS Yosemite (10.10)
- macOS El Capitan (10.11)
- macOS Sierra (10.12)
- macOS High Sierra (10.13)
- macOS Mojave (10.14)
- macOS Catalina (10.15)
Older versions may work but aren't regularly tested. Bug reports for older versions are welcome.
Download the script:
curl --remote-name https://raw.githubusercontent.com/steve-ross/laptop/master/mac
Review the script (avoid running scripts you haven't read!):
less mac
Execute the downloaded script:
sh mac 2>&1 | tee ~/laptop.log
Optionally, review the log:
less ~/laptop.log
Your last Laptop run will be saved to ~/laptop.log
.
Read through it to see if you can debug the issue yourself.
If not, copy the lines where the script failed into a
new GitHub Issue for us.
Or, attach the whole log file as an attachment.
macOS tools:
- Homebrew for managing operating system libraries.
macoOS Applications:
- 1Password password manager
- Adobe Creative Cloud for installing Adobe apps
- Dropbox for cloud storage
- Env Key to manage dotfiles and environment variables
- Google Chrome, the web browser
- GitKracken to better visualize and manage git
- Harvest for time tracking
- iTerm2 to replace the default console app
- Moom for arranging windows
- No IP Dynamic Update Client for managing dynamic IPs
- Skitch for screenshot annotations
- Slack for team / collaborative communications
- Spotify for music
- Transmit for all things remote storage (FTP etc)
- Visual Studio Code text editor for programming
Unix tools:
- Autojump to move between directories
- Direnv and Direnv Helpers to auto-layout projects
- Fish as your shell
- Terminal Notifier long running shell process alerts/notifications
- Git for version control
- OpenSSL for Transport Layer Security (TLS)
- RCM for managing company and personal dotfiles
- The Silver Searcher for finding things in files
- Tmux for saving project state and switching between projects
- Watchman for watching for filesystem events
Heroku tools:
- Heroku CLI and Parity for interacting with the Heroku API
GitHub tools:
Image tools:
- GraphicksMagick for cropping and resizing images
Programming languages, package managers, and configuration:
- Node Version Manager for managing node versions
- Node.js and npm, for running apps and installing JavaScript packages
- Yarn for managing JavaScript packages
Databases:
- [Mongo] for storing document data
- Redis for storing key-value data
It should take less than 15 minutes to install (depends on your machine).
Your ~/.laptop.local
is run at the end of the Laptop script.
Put your customizations there.
For example:
#!/bin/sh
brew bundle --file=- <<EOF
brew "Caskroom/cask/dockertoolbox"
brew "go"
brew "ngrok"
brew "watch"
EOF
default_docker_machine() {
docker-machine ls | grep -Fq "default"
}
if ! default_docker_machine; then
docker-machine create --driver virtualbox default
fi
default_docker_machine_running() {
default_docker_machine | grep -Fq "Running"
}
if ! default_docker_machine_running; then
docker-machine start default
fi
fancy_echo "Cleaning up old Homebrew formulae ..."
brew cleanup
brew cask cleanup
if [ -r "$HOME/.rcrc" ]; then
fancy_echo "Updating dotfiles ..."
rcup
fi
Write your customizations such that they can be run safely more than once.
See the mac
script for examples.
Laptop functions such as fancy_echo
and
gem_install_or_update
can be used in your ~/.laptop.local
.
See the wiki for more customization examples.
Edit the mac
file.
Document in the README.md
file.
Follow shell style guidelines by using ShellCheck and Syntastic.
brew install shellcheck
Thank you, contributors!
By participating in this project, you agree to abide by the thoughtbot code of conduct.
Laptop is © 2011-2020 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.