mickzeller / dotfiles

Home for my bootstrap script, dotfiles, and configuration files

This repository contains my base setup for a new computer along with a number of bash scripts and bash scripting utilities. It is opinionated and based on my own work flows. I highly recommend that you read through the files and customize them for your own purposes.

Included here are:

• Dotfiles for both BASH and ZSH
• A series of bash scripts performing different useful functions
• Scripting templates and utilities
• Bootstrap scripts to automate the process of provisioning a new computer or VM.

Disclaimer: I am not a professional or trained programmer and I bear no responsibility whatsoever if any of these scripts wipes your computer, destroys your data, burns your toast, crashes your car, or otherwise causes mayhem and destruction. Please configure these to your own needs and USE AT YOUR OWN RISK.

Files and organization

The file organization is as follows:

• bin/ - A collection of BASH scripts that I have found very helpful over the years
• bootstrap/ - Scripts and utilities to bootstrap a new Mac or Linux computer/VM
• config/ - Contains the elements needed to configure your environment and specific apps.
  • config/dotfiles/ - Ahem, dotfiles.
  • config/iterm/ - My preferred iTerm configuration
  • config/shell/ - Aliases and other goodies that are sourced by either BASH or ZSH
• scripting/ - Shell scripting utilities and templates
• test/ - Unit tests written using BATS

IMPORTANT: Unless you want to use my defaults, make sure you review the files in config/ to configure your own aliases, preferences, etc.

Cloning this repo to a new Mac

To make cloning this repo easy on a new Mac, I created a gist which can easily be run with the following command:

curl -SL https://gist.githubusercontent.com/natelandau/b3e1dfba7491137f0a0f5e25721fffc2/raw/d98763695a0ddef1de9db2383f43149005423f20/bootstrapNewMac | bash

This gist creates a script ~/bootstrap.sh in your home directory which completes the following tasks

1. Creates a new public SSH key if needed
2. Copies your public key to your clipboard
3. Opens Github to allow you to add this public key to your 'known keys'
4. Clones this repo to your home directory

See, easy. Now you're ready to run one of the bootstrap scripts and get your new computer working.

A Note on Code Reuse

Many of the scripts, configuration files, and other information herein were compiled by me over many years without ever having the intention to make them public. As a novice programmer, I have Googled, GitHubbed, and StackExchanged a path to solve my own scripting needs. Quite often I lift a function whole-cloth from a GitHub repo don't keep track of it's original location. I have done my best within these files to recreate my footsteps and give credit to the original creators of the code when possible. Unfortunately, I fear that I missed as many as I found. My goal of making this repository public is not to take credit for the wonderful code written by others. If you recognize something that I didn't credit, please let me know.