Welcome to my personal dotfiles repository! This collection houses all the configuration files, customizations, and themes that I use to tailor my Linux and macOS environments for an optimal experience.
-
Configuration Files 📝:
All my config files for various applications (shell, editor, window manager, etc.) are version-controlled and organized here for easy setup and maintenance. -
Customizations ⚙️:
From aliases and environment variables to plugin settings and system tweaks, you'll find everything I use to streamline my workflow. -
Themes and Aesthetics 🎨:
I include various themes and visual customizations to create a consistent and visually appealing environment across all my systems. -
Automation and Scripts ⚡:
Custom scripts and bootstrap tools automate the setup process, making it simple to deploy my personalized environment on any new machine.
-
(macOS only) Install Apple’s Command Line Tools:
If you’re on macOS, install these prerequisites (needed for Git and Homebrew):xcode-select --install
-
Clone the Repository:
# Use SSH (if set up)... git clone git@github.com:UBONGFX/.dotfiles.git # ...or else use HTTP and switch to remote later. git clone https://github.com/username/dotfiles.git ~/.dotfiles
-
Install Homebrew Packages & Apps:
Bootstrap Homebrew itself (if missing), then install your formulae, casks, and fonts.- Default (no flag): installs everything (base + office casks + private casks + fonts)
--base: only core formulae + base casks + fonts--office: base + office casks--private: base + private casks- Note (Linux): on Linux the script always runs in default mode but installs only core formulae (casks and fonts are not supported)
cd ~/.dotfiles # Default (all, macOS only): source ./scripts/brew-bootstrap.sh # Or limit to base only (also the only mode on Linux): source ./scripts/brew-bootstrap.sh --base # Or include office GUI apps only: source ./scripts/brew-bootstrap.sh --office # Or install private casks only: source ./scripts/brew-bootstrap.sh --private
-
Run the Dotfiles Bootstrap Script:
Back up any existing dotfiles and create symlinks to your repo.- Normal mode (default): moves old files to a backup folder and replaces them with symlinks.
- Soft mode (
--soft): preserves any existing files in place (no backup or linking).
# Use this to force changes... ./scripts/bootstrap.sh # ..or use it with the soft flag ./scripts/bootstrap.sh --soft
-
Set Your Login Shell to Homebrew Zsh:
Ensure you’re running the Homebrew‑installed Zsh as your default login shell:- Registers the brew‑installed Zsh in /etc/shells if needed.
- Runs chsh to update your login shell.
- Enter your password when prompted to authorize the change.
sudo ./scripts/set_shell.sh
-
Reload or Restart Your Shell:
For all changes to take effect, either open a new terminal window or reload your current session with:source ~/.zshrc
I use Bats Core to validate the scripts. You can install it via Homebrew.
Run the tests
From the repo root, execute:
bats --tap tests/ If you plan to work on the scripts or run the tests locally, I strongly recommend using the included DevContainer.
It gives you a clean, isolated environment that matches CI.
- Install VS Code’s Remote – Containers extension.
- Reopen this folder in a container when prompted.
Thanks for checking out my dotfiles—feel free to
- open an issue if you hit any snags
- submit a PR with improvements
Happy coding! 🚀