My macOS / Ubuntu dotfiles.
Shamelessly copied from https://github.com/oyvinmar/dotfiles (who again copied from https://github.com/cowboy/dotfiles, who again... yeah, you get the picture...)
Some notable tweaks:
- Removed oyvinmars additions for Volta, Teamocil and Hyper
- Automatic addition of private ssh keys found in
~/.sshto Keychain - Added support for applications in Mac App Store
I finally decided that I wanted to be able to execute a single command to "bootstrap" a new system to pull down all of my dotfiles and configs, as well as install all the tools I commonly use. In addition, I wanted to be able to re-execute that command at any time to synchronize anything that might have changed. Finally, I wanted to make it easy to re-integrate changes back in, so that other machines could be updated.
That command is dotfiles, and this is my "dotfiles" Git repo.
When dotfiles is run for the first time, it does a few things:
- In Ubuntu, Git is installed if necessary via APT (it's already there in macOS).
- This repo is cloned into your user directory, under
~/.dotfiles. - Files in
/copyare copied into~/. (read more) - Files in
/linkare symlinked into~/. (read more) - Files in
/configare symlinked into~/.config. (read more) - You are prompted to choose scripts in
/initto be executed. The installer attempts to only select relevant scripts, based on the detected OS and the script filename. - Your chosen init scripts are executed (in alphanumeric order, hence the funky names). (read more)
On subsequent runs, step 1 is skipped, step 2 just updates the already-existing repo, and step 6 remembers what you selected the last time. The other steps are the same.
- The
/backupsdirectory gets created when necessary. Any files in~/that would have been overwritten by files in/copyor/linkget backed up there. - The
/bindirectory contains executable shell scripts (including the dotfiles script) and symlinks to executable shell scripts. This directory is added to the path. - The
/cachesdirectory contains cached files, used by some scripts or functions. - The
/confdirectory just exists. If a config file doesn't need to go in~/, reference it from the/confdirectory. - The
/sourcedirectory contains files that are sourced whenever a new shell is opened (in alphanumeric order, hence the funky names). - The
/testdirectory contains unit tests for especially complicated bash functions. - The
/vendordirectory contains third-party libraries.
Any file in the /copy subdirectory will be copied into ~/. Any file that needs to be modified with personal information (like copy/.gitconfig which contains an email address and private key) should be copied into ~/. Because the file you'll be editing is no longer in ~/.dotfiles, it's less likely to be accidentally committed into your public dotfiles repo.
Any file in the /link subdirectory gets symlinked into ~/ with ln -s. Edit one or the other, and you change the file in both places. Don't link files containing sensitive data, or you might accidentally commit that data! If you're linking a directory that might contain sensitive data (like ~/.ssh) add the sensitive files to your .gitignore file!
Same as the link step except that all files get symlinked into ~/.config.
Scripts in the /init subdirectory will be executed. A whole bunch of things will be installed, but only if they aren't already.
- Minor XCode init via the init/10_osx_xcode.sh script
- Homebrew via the init/20_osx_homebrew.sh script
- Homebrew recipes via the init/30_osx_homebrew_recipes.sh script
- Homebrew casks via the init/30_osx_homebrew_casks.sh script
- APT packages and git-extras via the init/20_ubuntu_apt.sh script
Because the dotfiles script is completely self-contained, you should be able to delete everything else from your dotfiles repo fork, and it will still work. The only thing it really cares about are the /copy, /link and /init subdirectories, which will be ignored if they are empty or don't exist.
If you modify things and notice a bug or an improvement, file an issue or a pull request and let me know.
Also, before installing, be sure to read my gently-worded note.
You need to have XCode or, at the very minimum, the XCode Command Line Tools, which are available as a much smaller download.
The easiest way to install the XCode Command Line Tools in macOS 10.9+ is to open up a terminal, type xcode-select --install and follow the prompts.
Tested in macOS 10.14
You might want to set up your ubuntu server like I do it, but then again, you might not.
Either way, you should at least update/upgrade APT with sudo apt-get -qq update && sudo apt-get -qq dist-upgrade first.
Not tested
If you're not me, please do not install dotfiles directly from this repo!
Why? Because I often completely break this repo while updating. Which means that if I do that and you run the dotfiles command, your home directory will burst into flames, and you'll have to go buy a new computer. No, not really, but it will be very messy.
- Read my gently-worded note
- Fork this repo
- Open a terminal/shell and do this (change
runestoandmasteras appropriate):
export DOTFILES_GH_USER=runesto
export DOTFILES_GH_BRANCH=master
bash -c "$(wget -qO- https://raw.github.com/$DOTFILES_GH_USER/dotfiles/$DOTFILES_GH_BRANCH/bin/dotfiles)" && source ~/.bashrcexport DOTFILES_GH_USER=runesto
export DOTFILES_GH_BRANCH=master
bash -c "$(curl -fsSL https://raw.github.com/$DOTFILES_GH_USER/dotfiles/$DOTFILES_GH_BRANCH/bin/dotfiles)" && source ~/.bashrcSince you'll be using the dotfiles command on subsequent runs, you'll only have to set the DOTFILES_GH_USER variable for the initial install, but if you have a custom branch, you will need to export DOTFILES_GH_BRANCH for subsequent runs.
There's a lot of stuff that requires admin access via sudo, so be warned that you might need to enter your password here or there.
bash -c "$(wget -qO- https://raw.github.com/runesto/dotfiles/master/bin/dotfiles)" && source ~/.bashrcbash -c "$(curl -fsSL https://raw.github.com/runesto/dotfiles/master/bin/dotfiles)" && source ~/.bashrcTo keep things easy, the ~/.bashrc and ~/.bash_profile files are very simple, and should never need to be modified. Instead, add your aliases, functions, settings, etc into one of the files in the source subdirectory, or add a new file. They're all automatically sourced when a new shell is opened. Take a look, I have a lot of aliases and functions.
In addition to the aforementioned dotfiles script, there are a few other bin scripts.
- dotfiles - (re)initialize dotfiles. It might ask for your password (for
sudo). - src - (re)source all files in
/sourcedirectory - Look through the bin subdirectory for a few more.
Copyright (c) 2019 Rune Storløpa Licensed under the MIT license.