Brennan's Comfy Dotfiles
A collection of dotfiles for macOS that make your terminal experience comfortable, productive, and visually pleasing with a consistent Gruvbox theme.
Features: Gruvbox colours β’ Starship prompt β’ Productive shell β’ Git config β’ Micro editor β’ Tmux setup β’ One-click install
What's Included
Shell Environment
- Zsh with modern features and completions
- Starship prompt with Gruvbox theme
- Welcome script showing system stats and random quotes
- 50+ aliases for common commands
- Utility functions for development
Git Configuration
- 80+ aliases for common workflows
- GPG signing enabled
- Better diff and merge tools
- Colorized output
- Useful status formats
Editor & Tools
- Micro editor with Gruvbox theme
- Tmux with intuitive keybindings
- Node.js configuration (.npmrc, .nvmrc)
- Homebrew package list (Brewfile)
System Optimization
- macOS defaults script for sane settings
- Finder improvements
- Dock customization
- Security enhancements
Quick Installation
# Extract the zip file
unzip dotfiles.zip
cd dotfiles
# Run the installer
./install.sh
# Restart your terminal
source ~/.zshrc
The installer will:
- Backup your existing dotfiles
- Create symlinks to the new configurations
- Install Homebrew packages
- Apply macOS system defaults
Essential Shortcuts
Navigation
ll # List files in detail (using eza)
la # List all files including hidden
mkcd <dir> # Create and enter directory
.. # Go up one directory
... # Go up two directories
Git Workflow
gst # Git status - short format
glog # Git log with graph
ga # Git add
gcmsg "msg" # Git commit with message
gp # Git push
gl # Git pull
gco <branch> # Checkout branch
Development
nr dev # npm run dev
nrb # npm run build
yarn start # Start with yarn
serve # Start HTTP server in current directory
Utilities
weather # Show weather forecast
myip # Show public IP address
localip # Show local IP address
speedtest # Test internet speed
extract file.zip # Extract any archive
Theme Preview
The dotfiles use the Gruvbox color scheme throughout:
- Warm, eye-friendly colors
- High contrast for readability
- Consistent appearance across all tools
Terminal Welcome
Every new terminal session shows:
- System information (OS, uptime, memory, disk, IP)
- Battery status (on laptops)
- Git repository status
- Random motivational quote
Starship Prompt
A clean prompt showing:
- Username and hostname
- Current directory
- Git branch and status
- Active development tools (Node, Python, Rust, Go)
- Current time
File Structure
dotfiles/
βββ .zshrc # Zsh configuration
βββ .gitconfig # Git configuration
βββ .tmux.conf # Tmux configuration
βββ .micro/
β βββ settings.json # Micro editor settings
βββ .npmrc # NPM configuration
βββ .nvmrc # Default Node.js version
βββ starship.toml # Starship prompt configuration
βββ welcome.sh # Terminal welcome script
βββ Brewfile # Homebrew packages
βββ macos-defaults.sh # macOS system defaults
βββ install.sh # Installation script
βββ README.md # Documentation
Customization
Adding Personal Configs
Create a .zshrc.local file for personal customizations:
# ~/.zshrc.local
alias myproject="cd ~/Development/myproject"
export MY_VAR="value"
Starship Prompt
Edit ~/.config/starship.toml to customize the prompt appearance.
Micro Editor
Add plugins or modify settings in ~/.config/micro/settings.json.
Requirements
- macOS 10.15+ (Catalina or newer)
- Zsh (default on modern macOS)
- Homebrew (installed by script)
- Internet connection for package installation
Manual Setup
If you prefer manual installation:
# Create symlinks
ln -s ~/dotfiles/.zshrc ~/.zshrc
ln -s ~/dotfiles/.gitconfig ~/.gitconfig
ln -s ~/dotfiles/.tmux.conf ~/.tmux.conf
ln -s ~/dotfiles/.micro ~/.micro
ln -s ~/dotfiles/.npmrc ~/.npmrc
ln -s ~/dotfiles/.nvmrc ~/.nvmrc
ln -s ~/dotfiles/starship.toml ~/.config/starship.toml
# Install Homebrew packages
brew bundle --file ~/dotfiles/Brewfile
# Apply macOS defaults
bash ~/dotfiles/macos-defaults.sh
Contributing
Found a bug or have a suggestion?
- Open an issue on GitLab
- Submit a pull request with your improvements
- Share your customizations!
License
MIT License. Feel free to use these dotfiles as a base for your own setup.
Pro Tip: After installation, set your terminal font to Fira Code, JetBrains Mono, or Hack Nerd Font for the best experience! The Starship prompt works with any font, but these look great.