Laptop is a script to set up an OS X computer for web 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:
- OS X El Capitan (10.11)
- OS X Yosemite (10.10)
- OS X Mavericks (10.9)
Older versions may work but aren't regularly tested. Bug reports for older versions are welcome.
Begin by opening the Terminal application on your Mac. The easiest way to open
an application in OS X is to search for it via Spotlight. The default
keyboard shortcut for invoking Spotlight is command-Space. Once Spotlight
is up, just start typing the first few letters of the app you are looking for,
and once it appears, press return to launch it.
In your Terminal window, copy and paste each of these three commands one at a
time, then press return after each one. The first two commands download the
files the script needs to run, and the third command executes the script.
curl --remote-name https://raw.githubusercontent.com/18F/laptop/master/mac
curl --remote-name https://raw.githubusercontent.com/18F/laptop/master/Brewfile
bash mac 2>&1 | tee ~/laptop.logThe script itself is available in this repo for you to review if you want to see what it does and how it works.
Note that the script will ask you to enter your OS X password at various points. This is the same password that you use to log in to your Mac. If you don't already have it installed, GitHub for Mac will launch automatically at the end of the script so you can set up everything you'll need to push code to GitHub.
Once the script is done, make sure to quit and relaunch Terminal.
More detailed instructions with a video are available in the Wiki.
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 and paste the entire log into a
new GitHub Issue for us.
- CloudApp for sharing screenshots and making an animated GIF from a video
- Cloud Foundry CLI for command line access to 18F's Cloud Foundry-based application platform
- Flux for adjusting your Mac's display color so you can sleep better
- GitHub Desktop for setting up your SSH keys automatically
- Homebrew for managing operating system libraries
- Homebrew Cask for quickly installing Mac apps from the command line
- Homebrew Services so you can easily stop, start, and restart services
- hub for interacting with the GitHub API
- MySQL for storing relational data
- n for managing Node.js versions if you do not have Node.js already installed (Includes latest Node.js and NPM, for running apps and installing JavaScript packages)
- PhantomJS for headless website testing
- Postgres for storing relational data
- pyenv for managing Python versions if you do not have Python already installed (includes the latest 3.x Python)
- Redis for storing key-value data
- RVM for managing Ruby versions (includes Bundler and the latest Ruby)
- Slack for communicating with your team
- Sublime Text 3 for coding all the things
- The Silver Searcher for finding things in files
- Virtualenv for creating isolated Python environments (via pyenv if it is installed)
- Virtualenvwrapper for extending Virtualenv (via pyenv if it is installed)
- Zsh as your shell
It should take less than 15 minutes to install (depends on your machine and internet connection).
Your ~/.laptop.local is run at the end of the mac script.
Put your customizations there. This repo already contains a .laptop.local
you can use to get started.
# Go to your OS X user's root directory
cd ~
# Download the sample file to your computer
curl --remote-name https://raw.githubusercontent.com/18F/laptop/master/.laptop.localIt lets you install the following tools:
- Atom - GitHub's open source text editor
- Exuberant Ctags for indexing files for vim tab completion
- Firefox for testing your website on a browser other than Chrome
- iTerm2 - an awesome replacement for the OS X Terminal
- reattach-to-user-namespace to allow copy and paste from Tmux
- Tmux for saving project state and switching between projects
- Vim for those who prefer the command line
For example:
#!/bin/sh
fancy_echo "Running your customizations from ~/.laptop.local ..."
brew bundle --file=- <<EOF
cask 'atom'
cask 'firefox'
cask 'iterm2'
brew 'vim'
brew 'ctags'
brew 'tmux'
brew 'reattach-to-user-namespace'
brew 'go'
EOF
append_to_file "$HOME/.zshrc" 'export PATH="$PATH:/usr/local/opt/go/libexec/bin"'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.
Most of what the script installs is listed in the Brewfile. If you don't want
the script to install certain tools, you can remove them from the Brewfile.
The script does not automatically launch these services after installation because you might not need or want them to be running. With Homebrew Services, starting, stopping, or restarting these services is as easy as:
brew services start|stop|restart [name of service]
For example:
brew services start redis
To see a list of all installed services:
brew services list
To start all services at once:
brew services start --all
The 18F laptop script is based on and inspired by thoughtbot's laptop script.
thoughtbot's original work remains covered under an MIT License.
18F's work on this project is in the worldwide public domain, as are contributions to our project. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.