🏗️ Foundation | 📐 Layout | 🛋️ Furniture | 📦 Unpack | 🛠️ Maintain | 💡 Inspiration
I wanted a workstation that made me feel at home. It had to be:
- 🔧 Functional - Simple to use and bloat-free
- ⚡ Fast - Automated and keyboard-first
- ✨ Fun - Make work painless
This repository contains the blueprint for that home. These dotfiles allow me to seamlessly move into a new workstation by automatically furnishing it with the appliances and tools I use every day.
A lot of what is here was inspired by others. Like many of them, I have made this repo public to serve as an open house for those on a similar journey. Feel free to take a look around and copy what you like. However, I do not recommend forking because my setup is both custom and highly volatile.
To keep things tidy, this repo is organized into a few main directories:
- 💾 backup - Static assets and configs that require manual setup
- 🗄️ bin - Small, custom executables to be appended to
PATH - 🎨 config - Configs to be symlinked into place
The floor plan at a glance:
| Operating System |  |
|---|---|
| Package Manager |  |
| Dotfile Manager |  |
| Launcher |  |
| Tiling Window Manager |  |
| Status Bar |  |
| Web Browser |  |
| Password Manager |  |
| Music Player |   |
| Note Manager |  |
| Terminal Emulator & Mux |   |
| Shell |    |
| Editor |   |
| Version Control System |   |
| Typeface | Space Mono |
| Colorscheme |  |
| Programming Languages |      |
For the complete list of packages and apps that get installed, see the Brewfile.
The main installation script is unpack.sh. It explains what it
will do, prompts for confirmation before each step, and is idempotent.
In brief, unpacking...
- ✅ Verifies system compatibility
- 🔄 Checks for system updates
- ⬇️ Installs (or updates) packages and apps
- 🔗 Symlinks configs
- ⚙️ Applies system settings
Warning
Before unpacking, review the repo layout and backup any pre-existing configs.
Clone this repo and run unpack.sh:
git clone https://github.com/boldandbrad/dotfiles.git ~/Dotfiles
cd ~/Dotfiles && ./unpack.shTo make system maintanence simpler after unpacking, a handful of convenient cli tools are provided. See bin for more details.
| Command | Description |
|---|---|
mac |
Install dependencies and view system info |
slinky |
Manage dotfile symlinks |
tidyup |
Clean system caches and app data |
There are plenty of great dotfile repos and machine setup resources out there. In particular, I took inspiration from these gems:
- Dotfiles Community 🔗 - a great collection of dotfile resources
- dotfyle 🔗 - discover neovim plugins and configurations, including mine
- dotfile repos 🔗 - my favorite github dotfile repositories
Many of the wallpaper assets found in this repo have been copied from the following sources:
- catppuccin-waves-4k.png - Credit zhichaoh/catppuccin-wallpapers
- OS Wallpapers. Credit thismoon/catppuccin-wallpapers
Copyright (c) 2021-present Bradley Wojcik. Released under the MIT License. See LICENSE for details.